Skip to content
UltimateTeam.ai Docs

Set operator-managed tenant flags (is_simulated)

PATCH
/api/v1/admin/tenants/{tenant_id}

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

Parameters

Path Parameters

tenant_id
required

Target tenant UUID

string

Target tenant UUID

Request Body required

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.

object
is_simulated
Any of:
boolean

Responses

200

Successful Response

Result of a tenant-flag PATCH.

object
changed
required
Array<string>
is_simulated
required
boolean
tenant_id
required
string

422

Validation Error

object
detail
Array<object>
object
ctx
object
input
loc
required
Array
msg
required
string
type
required
string