Account Invitations
Create account invitation
Account Invitations
Create account invitation
Create a new account invitation
POST
/
account-invitations
Authorizations
Authorization
string
headerrequiredBody
application/json
name
string
requiredName of the user the invitation is for
email
string
requiredEmail address of the user
role
enum<string>
requiredRole of the user when they accept the invitation
Available options:
admin, member Response
201 - application/json
name
string
requiredName of the user the invitation is for
email
string
requiredEmail address of the user
role
enum<string>
requiredRole 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 and time when the invitation was created
updated_at
string
Date and time when the invitation was last updated
deleted_at
string
Date and time when the invitation was cancelled