Skip to main content
POST

Authorizations

Authorization
string
header
required

User PAT (cliq_tok_…, including session-scoped) or realm token (cliq_dt_…).

Body

application/json
target_type
enum<string>
required

org or realm.

Available options:
org,
realm
email
string
required

The person's email address.

Minimum string length: 1
org_id
string<uuid>

target_type: org: the organization.

realm_id
string

target_type: realm: the realm.

Minimum string length: 1
role
enum<string>

member (default), admin, owner (organizations) or operator (realms).

Available options:
owner,
admin,
member,
operator
reactivate
boolean

Site administrators: restore the deleted account that holds the email.

Response

Success.

ok
enum<boolean>
required

Always true on success.

Available options:
true
data
object
required