Sign in
invites

Create a new invite

Send an invitation to a user to join an organization with a specific role

post/invites

Request

  • The document declares no server URL.
  • Auth: none declared

Request body

emailstring required

Email address of the person to invite

role'admin' | 'manager' | 'user' required

Role to assign to the invited user

Example request

{
  "email": "user@example.com",
  "role": "user"
}

Response

The invite has been successfully created

urlstring nullable required

URL of the invite, returned when not using email configuration

Example response

{
  "url": "https://example.com/invite/123e4567-e89b-12d3-a456-426614174000"
}

Changes

No recorded changes to this operation across all 50 revisions of this API.