On this page
tenant_settings.update
Rename the organization and/or change retention (retention is a version compare-and-set)
Request
PUT /api/v1/tenant/settings
- MCP:
tenant_settings_update - SDK:
client.tenant_settings.update(SDK path arguments usepath; MCP usesparams). - Minimum API key role: admin.
- Idempotency: natural.
Use the request schema below. Read IDs from earlier operation results.
Input schema
json
{
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TenantSettingsUpdateRequest"
}
}
}
}
}
Responses
json
{
"200": {
"description": "Rename the organization and/or change retention (retention is a version compare-and-set)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TenantSettingsGetResponse200"
}
}
}
},
"4XX": {
"description": "Typed error (ApiError)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"5XX": {
"description": "Typed error (ApiError)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
}
Referenced schemas
json
{
"components": {
"schemas": {
"TenantSettingsUpdateRequest": {
"type": "object",
"properties": {
"display_name": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"nullable": true
},
"retention": {
"type": "object",
"properties": {
"recording_days": {
"type": "integer",
"minimum": 1,
"maximum": 3650
},
"transcript_days": {
"type": "integer",
"minimum": 1,
"maximum": 3650
},
"document_days": {
"type": "integer",
"minimum": 1,
"maximum": 3650,
"nullable": true
},
"expected_version": {
"type": "integer",
"minimum": 0
}
},
"required": [
"recording_days",
"transcript_days",
"document_days",
"expected_version"
],
"additionalProperties": false
}
},
"additionalProperties": false
},
"TenantSettingsGetResponse200": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"display_name": {
"type": "string",
"nullable": true
},
"retention": {
"type": "object",
"properties": {
"recording_days": {
"type": "integer",
"minimum": 1,
"maximum": 3650
},
"transcript_days": {
"type": "integer",
"minimum": 1,
"maximum": 3650
},
"document_days": {
"type": "integer",
"minimum": 1,
"maximum": 3650,
"nullable": true
},
"source": {
"type": "string",
"enum": [
"platform_default",
"tenant"
]
},
"version": {
"type": "integer",
"minimum": 0
}
},
"required": [
"recording_days",
"transcript_days",
"document_days",
"source",
"version"
],
"additionalProperties": false
}
},
"required": [
"name",
"display_name",
"retention"
],
"additionalProperties": false
},
"ApiError": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"unauthenticated",
"forbidden",
"not_found",
"conflict",
"invalid_request",
"idempotency_conflict",
"policy_denied",
"capability_unavailable",
"provider_unavailable",
"knowledge_unavailable",
"publication_invalid",
"run_not_active",
"rate_limited",
"outcome_unknown",
"internal"
]
},
"message": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"outcome": {
"type": "string",
"enum": [
"none",
"unknown"
]
},
"details": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"code",
"message",
"retryable",
"outcome"
],
"additionalProperties": false
}
},
"required": [
"error"
],
"additionalProperties": false
}
}
}
}
Errors and recovery
See API error handling and Troubleshooting.
Related guides
Content version 80630bdbMarkdown source