Admiral
Tenant

Update the current tenant

PATCH
/v1/tenant

Only display_name and labels are mutable. slug is part of the account's identity and status is set by lifecycle operations, neither of which a tenant performs on itself.

Scope: tenant:write

Authorization

bearerAuth
AuthorizationBearer <token>

Personal Access Token (PAT) or Service Access Token (SAT). Pass the token in the Authorization header: Bearer admp_...

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

UpdateTenantRequest carries only the mutable fields. The tenant is the caller's own, so there is no id here.

Response Body

application/json

curl -X PATCH "https://example.com/v1/tenant" \  -H "Content-Type: application/json" \  -d '{}'
{  "tenant": {    "id": "string",    "slug": "string",    "display_name": "string",    "status": "TENANT_STATUS_UNSPECIFIED",    "labels": {      "property1": "string",      "property2": "string"    },    "created_at": "2023-01-15T01:30:15.01Z",    "updated_at": "2023-01-15T01:30:15.01Z"  }}