Skip to main content
POST
/
api
/
v1
/
tenants
Create a new tenant (only allowed for default tenant)
curl --request POST \
  --url https://api.example.com/api/v1/tenants \
  --header 'Content-Type: application/json' \
  --header 'x-calry-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "domain": "<string>",
  "isDefault": true
}
'
{
  "id": "<string>",
  "domain": "<string>",
  "name": "<string>",
  "workspaceID": "<string>",
  "isDefault": true,
  "status": "ACTIVE",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
x-calry-api-key
string
header
required

Headers

​
x-calry-tenant-id
string

Optional tenant ID to specify which tenant to operate as. If not provided, the default tenant will be used.

Body

application/json
​
name
string
required

Tenant name

​
domain
string
required

Tenant domain

​
isDefault
boolean
required

Whether this is the default tenant for the workspace

Response

Tenant created

​
id
string
required
​
domain
string
required
​
name
string
required
​
workspaceID
string
required
​
isDefault
boolean
required
​
status
enum<string>
required
Available options:
ACTIVE,
INACTIVE
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required