Skip to main content
POST
Invite someone to the organization

Authorizations

Authorization
string
header
required

Headers

X-Workspace-Id
string<uuid>
required

UUID of the workspace to act in. Take it from GET /me (workspaces[].id). A key scoped to specific workspaces is rejected with 403 WORKSPACE_NOT_ALLOWED for any other id; a missing header is 400 WORKSPACE_REQUIRED.

Body

application/json
email
string<email>
required
Maximum string length: 320
role
enum<string>
default:member
Available options:
owner,
admin,
member
fullName
string
Required string length: 1 - 200

Response

Added or invited

data
object
required