User Invites
You can create and/or send out emails with invite codes that your users can use to sign up on the company-account.
Create user invite(s)
POST /user-invites
Parameters
emails
array- Required
emails.*
string- Must be a valid email and not exist
- Required
team_id
integer
Payload
{
"emails": [
"john.doe@example.com",
"firstname.lastname@example.com"
],
"team_id": 1,
}
Response
Status code 201
{
"data": [
{
"invite_token": "8a2b2aad-9868-41a5-8f98-a356de5b9bcd",
"email": "john.doe@example.com"
},
{
"invite_token": "d9eb737e-2609-4b89-92bf-5bfd626653f4",
"email": "firstname.lastname@example.com"
}
]
}
Get invite tokens
GET /user-invites
Response
Status code 200
{
"data": [
{
"invite_token": "8a2b2aad-9868-41a5-8f98-a356de5b9bcd",
"email": "john.doe@example.com"
},
{
"invite_token": "d9eb737e-2609-4b89-92bf-5bfd626653f4",
"email": "firstname.lastname@example.com"
}
]
}
Delete invite token
DELETE /user-invites/:invite_token
Response
Status code 204
Create user with token
Please see the section Creating a user with an token