Skip to main content
POST
/
api
/
v3
/
users
Invite New User
curl --request POST \
  --url https://app.staging.sendo.so/api/v3/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user": {
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "<string>",
    "role": "<string>",
    "team_group_id": 123
  }
}
'
{
    "success": true,
    "message": "Invitation sent successfully",
    "receiver_email": "[email protected]",
    "team_group_id": 1234,
    "user_role": "manager",
    "invitation_status": "pending",
    "expires_at": "2023-11-11T12:18:55.000-08:00"
}

​
Body

​
user
object
required

​
Response

​
success
boolean
required
Wheter or not the invitation was successfully created
​
message
string
required
The response message
​
receiver_email
string
required
The email address that the invitation was addressed to
​
team_group_id
integer
required
The team group id that the user was invited to
​
user_role
string
required
The role that the new user was invited with
​
invitation_status
string
required
The invitation’s status. Valid values are pending, accepted, or expired.
​
expires_at
string
required
The date & time when the invitation will expire (in ISO 8601 format).
{
    "success": true,
    "message": "Invitation sent successfully",
    "receiver_email": "[email protected]",
    "team_group_id": 1234,
    "user_role": "manager",
    "invitation_status": "pending",
    "expires_at": "2023-11-11T12:18:55.000-08:00"
}