Skip to content

User Invite

Create

Example response:

{
"data": {
"id": "98815bd8-f3e6-41ec-8c4a-25a431ac6ce4",
"type": "user",
"attributes": {
...
}
}
}

This endpoint invites a user.

HTTP Request

POST /api/v1/users/:user_id/invite

URL Parameters

ParameterDescription
user_idThe ID of the user to invite

Delete

Example response:

{
"data": {
"id": "98815bd8-f3e6-41ec-8c4a-25a431ac6ce4",
"type": "user",
"attributes": {
...
}
}
}

This endpoint revokes a user invite.

HTTP Request

DELETE /api/v1/users/:user_id/invite

URL Parameters

ParameterDescription
user_idThe ID of the user to revoke an invite