Skip to main content
POST
/
account
/
api
/
v1
/
organizations
/
{org_id}
/
members
Invite a member
curl --request POST \
  --url https://www.closient.com/account/api/v1/organizations/{org_id}/members \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "email": "<string>",
  "role": "editor"
}
'
{
  "id": "<string>",
  "user_email": "<string>",
  "user_name": "<string>",
  "user_metadata": {},
  "role": "owner",
  "role_display": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.closient.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
org_id
string<shortuuid>
required

UUID of the organization.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Body

application/json

Request schema for inviting a member to an organization.

​
email
string
required

Email address of the user to invite.

​
role
enum<string>
default:editor

Role to assign to the new member.

Available options:
owner,
manager,
billing,
editor

Response

OK

Response schema for a membership record.

​
id
string<shortuuid>
required

URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
​
user_email
string
required

Email address of the member's user account.

​
user_name
string
required

Display name of the member's user account, if set.

​
user_metadata
User Metadata · object
required

Free-form metadata stored on the user account (Stripe-style key/value strings).

​
role
enum<string>
required

Role of the user in the organization.

Available options:
owner,
manager,
billing,
editor
​
role_display
string
required

Human-readable label for the role (localized).