Update a tenant (only allowed for default tenant)

Authorization

x-calry-api-key

x-calry-api-key<token>

In: header

Path Parameters

id*string

Tenant ID

Header Parameters

x-calry-tenant-id?string

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Tenant name

domain*string

Tenant domain

isDefault*boolean

Whether this is the default tenant for the workspace

Response Body

`application/json`

curl -X PATCH "https://example.com/api/v1/tenants/string" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "domain": "string",    "isDefault": true  }'

{
  "id": "string",
  "domain": "string",
  "name": "string",
  "workspaceID": "string",
  "isDefault": true,
  "status": "ACTIVE",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Empty