Skip to main content
POST
Invite a teammate as an admin

Authorizations

Authorization
string
header
required

Bearer token obtained from POST /api/v1.1/auth/token.

Headers

Idempotency-Key
string

Any string unique to this logical request. On a retry with the same key and the same request body, the original response is replayed verbatim (with an Idempotency-Replayed: true response header) instead of the action repeating. Reusing the key with a different body or on a different route returns 409 IDEMPOTENCY_KEY_REUSED. A replay attempted while the original call is still in flight returns 409 CONFLICT. Optional — omit it and the endpoint behaves exactly as it would otherwise.

Example:

"a1b2c3d4-idem-key-001"

Body

application/json
name
string
required
Required string length: 1 - 100
Example:

"Jane Doe"

email
string<email>
required
Example:

"jane@example.com"

role
enum<string>
required
Available options:
Admin,
RW Admin,
RO Admin,
Standard Admin
departments
string[]

Department ids this admin can manage. Required (non-empty) when role is "Standard Admin"; ignored otherwise.

Response

Invited (Auth0 invite email sent). status is always invited on creation.