Set operator-managed tenant flags (is_simulated)
const url = 'https://api.ultimateteam.ai/api/v1/admin/tenants/example';const options = { method: 'PATCH', headers: {'X-API-Key': '<X-API-Key>', 'Content-Type': 'application/json'}, body: '{"is_simulated":true}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PATCH \ --url https://api.ultimateteam.ai/api/v1/admin/tenants/example \ --header 'Content-Type: application/json' \ --header 'X-API-Key: <X-API-Key>' \ --data '{ "is_simulated": true }'Update operator-managed flags on a tenant (currently is_simulated).
Idempotent: patching a flag to its current value reports changed=[]
and writes no audit entry.
Args: body: Flags to set; omitted flags are untouched. tenant_id: The tenant to update. user: The authenticated platform operator (injected).
Returns: The tenant’s resulting flag values and which ones changed.
Raises: HTTPException 400: Invalid tenant id, or an empty patch. HTTPException 404: Tenant not found.
Authorizations
Section titled “Authorizations”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters”Target tenant UUID
Target tenant UUID
Request Bodyrequired
Section titled “Request Bodyrequired”Body for PATCH /admin/tenants/{tenant_id}.
Attributes: is_simulated: When set, marks the tenant as simulated (excluded from every cadence / trial-nurture / trial-expiry query) or clears the mark. Omitted = unchanged.
Examplegenerated
{ "is_simulated": true}Responses
Section titled “ Responses ”Successful Response
Result of a tenant-flag PATCH.
object
Examplegenerated
{ "changed": [ "example" ], "is_simulated": true, "tenant_id": "example"}Validation Error
object
object
object
Examplegenerated
{ "detail": [ { "ctx": {}, "input": "example", "loc": [ "example" ], "msg": "example", "type": "example" } ]}