Skip to content
UltimateTeam.ai Docs

Update tenant settings

PATCH
/api/v1/tenant

Partially update the tenant’s name or settings dict.

Authorizations

Request Body required

Request body for PATCH /tenant.

Attributes: name: New display name (optional). settings: Partial settings dict to merge (optional).

object
name
Any of:
string
<= 255 characters
settings
Any of:
object
key
additional properties
any

Responses

200

Successful Response

Wrapper response for GET /tenant.

Attributes: data: The tenant profile payload.

object
data
required

Tenant profile fields returned by GET /tenant.

Attributes: id: Unique tenant identifier. name: Display name of the tenant / business. slug: URL-safe unique identifier. plan: Current subscription plan tier. plan_status: Billing status (e.g. trialing, active). settings: Arbitrary tenant settings dict. token_budget_monthly: Monthly token allowance. tokens_used_this_month: Tokens consumed this month.

object
id
required
string format: uuid
name
required
string
plan
required
string
plan_status
required
string
settings
required
object
key
additional properties
any
slug
required
string
token_budget_monthly
required
integer
tokens_used_this_month
required
integer

422

Validation Error

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