Skip to main content
POST
/
api
/
user
/
institutionSendInvite
Email an invite link to a recipient
curl --request POST \
  --url https://pria.praxislxp.com/api/user/institutionSendInvite \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "institutionId": "60d5ec49f1b2c72b9c8e4d3a",
  "email": "newuser@example.com"
}
'
{
  "success": true,
  "message": "Invitation sent"
}

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 invite the recipient to

Example:

"60d5ec49f1b2c72b9c8e4d3a"

​
email
string<email>
required

Recipient email address

Example:

"newuser@example.com"

Response

Invitation email sent

​
success
boolean
Example:

true

​
message
string
Example:

"Invitation sent"