Sign in
Invites

Invite a teammate

Sends an invitation email to the address. Returns 201 with the new invite. If the address already has an invite in this organization, no second invite is created: the existing one is resent and returned with 200, keeping its original role. A revoked or rejected invite is reinstated as pending. An address that already accepted its invite is a member, so this returns 409.

post/v1/org/{org_id}/invites

Request body

emailstring email required

Address to send the invitation email to

role'user' | 'admin' | 'support' | 'cloud_rep' | 'restricted_user'

Role to grant on acceptance. Defaults to the organization's default role. Ignored when the address already has an invite.

Response

OK

org_idstring required

Organization the invite belongs to

emailstring required

Address the invite was sent to, and its identifier in this API

role'user' | 'admin' | 'support' | 'cloud_rep' | 'restricted_user' required

Role the invitee holds in the organization

status'invited' | 'accepted' | 'rejected' | 'revoked' required

'invited' is pending; 'accepted', 'rejected' and 'revoked' are final

invited_bystring nullable required

Email of the user who sent the invite

created_atstring date-time required

When the invite was first created

Changes

Changed in 1 of the 6 revisions of this API.1