Skip to main content
POST
/
v1
/
users
/
invite
Invite
curl --request POST \
  --url https://api.cadanapay.com/v1/users/invite \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "personId": "8ef9a712-cdae-4110-b1ea-9ba95abbee6e",
  "suppressWelcomeEmail": false,
  "returnLink": false
}
'
{
  "userId": "8ef9a712-cdae-4110-b1ea-9ba95abbee6e"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
X-MultiTenantKey
string

Required when using a Platform API token. The tenant key identifying which business to operate on.

Body

application/json

Invite user request payload

​
personId
string<uuid>
required
Example:

"8ef9a712-cdae-4110-b1ea-9ba95abbee6e"

​
suppressWelcomeEmail
boolean
default:false

Whether you want to suppress the welcome email with the sign up link

​
returnLink
boolean
default:false

Whether you want to get the unique sign up link in the api response

Response

invite user response

Invite user response

​
userId
string<uuid>
Example:

"8ef9a712-cdae-4110-b1ea-9ba95abbee6e"