Skip to main content
POST
/
api
/
v1
/
accounts
/
{account_id}
/
users
/
invite
Invite user to account
curl --request POST \
  --url http://localhost:9001/api/v1/accounts/{account_id}/users/invite \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "newuser@example.com"
}
'
{ "message": "User invitation sent successfully" }

Authorizations

​
Authorization
string
header
required

JWT token from Auth0

Path Parameters

​
account_id
string
required

Account's external ID (format: acct-xxx-v1)

Example:

"acct-xyz789-v1"

Body

application/json
​
email
string<email>
required

Email address of the user to invite

Example:

"newuser@example.com"

Response

Invitation sent successfully

​
message
string
Example:

"User invitation sent successfully"