Skip to main content
POST
Add a user by email

Authorizations

Authorization
string
header
required

Personal Access Token. Send as Authorization: Bearer hq_pat_....

Body

application/json
email
string
required

Email of the person to add. This is a lookup + dedup attribute only - the identity key is a stable UUID (external_user_id = workspace_users.id), so the same human survives an email change. One row per (direct source, lowercased email); re-inviting updates that row, keeping its UUID.

admin_access
string | null

default (normal member) or granted (tenant-admin from the start).

display_name
string | null

Response

User added / invited