Skip to main content
POST
/
api
/
user
/
institutionCreateJoinId
Create or retrieve institution join code
curl --request POST \
  --url https://pria.praxislxp.com/api/user/institutionCreateJoinId \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "institutionId": "60d5ec49f1b2c72b9c8e4d3a"
}
'
{
  "success": true,
  "data": {
    "joinId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  "message": "Successful joinId"
}

Authorizations

​
x-access-token
string
header
required

JWT token passed in x-access-token header

Body

application/json
​
institutionId
string
required

The institution ObjectId to create/retrieve a join code for

Example:

"60d5ec49f1b2c72b9c8e4d3a"

Response

Join code created or retrieved successfully

​
success
boolean
Example:

true

​
data
object
​
message
string
Example:

"Successful joinId"