Skip to main content
PUT
Join an institution

Authorizations

x-access-token
string
header
required

JWT token passed in x-access-token header

Body

application/json
institution
string
required

The institution ObjectId to join

Example:

"60d5ec49f1b2c72b9c8e4d3a"

referrer
string
required

The referrer user ObjectId. If different from the current user, the membership is set to pending and requires approval.

Example:

"60d5ec49f1b2c72b9c8e4d3b"

joinId
string

The twin's invite code, from an invitation link or typed by the person. Required when referrer is not the caller, and when the twin is not open to the caller.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Response

Joined successfully or membership already exists

success
boolean
Example:

true

ui
object

The created or existing UserInstitution document

message
string
Example:

"Joined successfully"