Skip to main content
POST
Add Admin

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

Add admin user request payload

email
string<email>
required
Example:

"admin@example.com"

firstName
string
required
Example:

"Jane"

lastName
string
required
Example:

"Smith"

roleId
string<uuid>
Example:

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

suppressWelcomeEmail
boolean
default:false

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

Response

add admin user response

Add admin user response

id
string<uuid>
Example:

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