Skip to main content
POST
Invite User

Headers

x-api-key
string | null

Your API key for programmatic access. Send it in the x-api-key header; you can create and manage keys from the Developers page.

Body

application/json
email
string
required

The email address to invite.

Example:

"john.doe@testmail.com"

seat_type
enum<string> | null

The product seat assigned when the invitation is accepted.

Available options:
workspace_admin,
workspace_member,
workspace_lite_member
group_ids
string[] | null

Workspace groups to apply after the invitation is accepted.

usage_limit
integer | null

Optional per-member usage limit to apply after the invitation is accepted.

Required range: x >= 0

Response

Successful Response

status
string
required

The status of the workspace invite request. If the request was successful, the status will be 'ok'. Otherwise an error message with status 500 will be returned.