Skip to main content
POST
Invite Teammate

Authorizations

Authorization
string
header
required

Bearer scheme name used by typed customer admin operations.

Body

application/json
email
string
required
Example:

"alice@acmecorp.com"

display_name
string | null
Example:

"Alice Example"

role_slug
string | null
Example:

"customer-reader"

Response

Invitation issued

customer_id
string<uuid>
required

Customer the invitee will join on acceptance.

customer_user_id
string<uuid>
required
email
string
required

Lowercased invitee email as persisted.

status
string
required
accept_invitation_url
string | null