Sign in
Organization
User

Invite member to organization

Send an invitation email to a user to join the organization. If the user doesn't exist, a pending user will be created.

post/v1/organizations/{organizationRef}/members/invite

Request body

emailstring email required

Email address of the user to invite.

role_idstring

Optional role ID to assign the user to when they accept the invitation.

Example request

{
  "email": "user@example.com",
  "role_id": "9bsv0s46s6s002p9ltq0"
}

Response

Example response

idstring required

ID of the newly created resource.

Changes

No recorded changes to this endpoint across all 25 revisions of this API.