Skip to main content
POST
/
account-invitations
Create account invitation
curl --request POST \
  --url https://cookiechimp.com/api/v1/account-invitations \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "email": "[email protected]",
  "role": "admin"
}
'
{
  "id": "inv123",
  "email": "[email protected]",
  "role": "member",
  "invited_by_type": "API",
  "created_at": "2023-01-25T09:30:20Z",
  "updated_at": "2023-01-25T09:30:20Z"
}

Authorizations

​
Authorization
string
header
required

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