Skip to main content
POST
Create account invitation

Authorizations

Authorization
string
header
required

API token obtained from the login endpoint or the dashboard

Body

application/json

Account invitation to create

name
string
required

Name of the user the invitation is for

email
string<email>
required

Email address of the user

role
enum<string>
required

Role of the user when they accept the invitation

Available options:
admin,
member

Response

Created account invitation

name
string
required

Name of the user the invitation is for

email
string<email>
required

Email address of the user

role
enum<string>
required

Role of the user when they accept the invitation

Available options:
admin,
member
id
string
invited_by_type
string

Type of entity that created the invitation (account_user or API)

invited_by_id
string | null

ID of the user who created the invitation

created_at
string<date-time>

Date and time when the invitation was created

updated_at
string<date-time>

Date and time when the invitation was last updated

deleted_at
string<date-time>

Date and time when the invitation was cancelled