Skip to content

Update tenant

PATCH /tenant/{id}

Path Parameters

idstring
required·

The tenant id.

Example: acme-corp

Query Parameters

environment_idstring · uuid

Required for session auth. Ignored for API tokens.

Example: 8a2b104d-74a6-47f2-b93e-c6b611e82391

Request Body

metadataRecord<string, any>

Full replacement of the metadata object.

Example: {"tier":"platinum"}
namestring

New display name.

Example: Acme Corporation

Response Body

created_atstring · date-time

The date and time when the tenant was created.

Example: 2026-07-02T09:14:03.117Z
environment_idstring · uuid

The environment this tenant belongs to.

Example: 8a2b104d-74a6-47f2-b93e-c6b611e82391
idstring

The tenant identifier — caller-chosen, URL-path-safe, and immutable once created. Composite primary key with environment_id, so the same value can exist independently in development, staging, and production. Must match ^[A-Za-z0-9._:@+-]{1,255}$.

Example: acme-corp
metadataRecord<string, any>

Free-form JSON object stored verbatim. Truto does not interpret this field — use it for tier, region, billing plan, or any other customer attribute your app cares about.

Example: {"tier":"gold","region":"wnam"}
namestring

Display name shown in the dashboard. Defaults to the tenant id on create if not supplied; can be edited later via PATCH /tenant/{id}.

Example: Acme Corp
updated_atstring · date-time

The date and time when the tenant was last updated.

Example: 2026-07-02T09:14:03.117Z
curl -X PATCH 'https://api.truto.one/tenant/{id}' \
  -H 'Authorization: Bearer <your_api_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Acme Corporation",
  "metadata": {
    "tier": "platinum"
  }
}'
const body = {
  "name": "Acme Corporation",
  "metadata": {
    "tier": "platinum"
  }
};

const response = await fetch('https://api.truto.one/tenant/{id}', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer <your_api_token>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(body),
});

const data = await response.json();
console.log(data);
import requests

url = "https://api.truto.one/tenant/{id}"
headers = {
    "Authorization": "Bearer <your_api_token>",
    "Content-Type": "application/json",
}
params = {
}
payload = {
    "name": "Acme Corporation",
    "metadata": {
        "tier": "platinum"
    }
}

response = requests.patch(url, headers=headers, params=params, json=payload)
print(response.json())