Skip to main content
POST
Invite a user by email

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
email
string<email>
required

Email address of the person to invite.

role
enum<string>

Role to grant the invitee. Defaults to admin when inviting to a new organization and member when inviting into an existing one.

Available options:
admin,
member
organization_id
string

Organization to invite the user into (e.g. "42"). Omit to create a new organization for the user on their first sign-in.

Response

Created

id
string
required

Invitation identifier

email
string
required

Invited email address

role
string
required

Role the invitee will be granted

organization_id
string

Organization the invitee will join. Absent when the invitation creates a new organization on first sign-in.