logo
UsersCreate invite

Create invite

Sends an invite for a new user to join the company. The message goes to the given email with the selected role.

Rules:

  • roleId must be a v4 UUID for a role in the company.
  • email must be valid.
  • You cannot invite an address that already has a pending invite or is already a member.
curl -X POST "https://api-sandbox.contasimples.com/users/v1/invites" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "roleId": "550e8400-e29b-41d4-a716-446655440000",
  "email": "user@company.com"
}'
{
  "message": "Invite created."
}
POST
/users/v1/invites
POST
Bearer Token
Bearer Tokenstring
Required

Bearer token from OAuth 2.0 client credentials. Format: Bearer {token}

Bearer token from OAuth 2.0 client credentials. Format: Bearer {token}
Content-Typestring
Required

The media type of the request body

Options: application/json
roleIdstring
Required

Role ID to assign. Must be a v4 UUID.

Format: uuid
emailstring
Required

Email the invite is sent to.

Format: email
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Bearer token from OAuth 2.0 client credentials. Format: Bearer {token}

Body

application/json
roleIdstring
Required

Role ID to assign. Must be a v4 UUID.

emailstring
Required

Email the invite is sent to.

Responses