Skip to main content
POST
Create an account invitation
Required scopes: accounts.invitations--my:rw

Authorizations

Authorization
string
header
required

Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.

Body

application/json
email
string
required

Email address of the invited account.

name
string

The name of the invited account (nick; first, second name; or both). If an invitation was issued to an existing account, this field will be replaced with the name assigned to that account.

product
string

The product to which an account is invited.

Response

OK: Returns an existing account's invitation ID.

invitation_id
string<uuid>

Unique account invitation identifier.