Skip to content
UltimateTeam.ai Docs

Toggle an agent identity capability

PATCH
/api/v1/settings/agent-identity

Enable or disable an agent’s email, phone, or card capability.

Authorizations

Request Body required

Request body for PATCH /settings/agent-identity.

Toggles exactly one capability (email, phone, or card) for one agent role. This flips the persisted *_enabled flag on the agent’s AgentIdentity row; it does not provision the underlying resource (email address, phone number, or Stripe Issuing card) — that is handled by POST /agents/{role}/identity.

object
card
Any of:

A single capability toggle within a PATCH /settings/agent-identity body.

object
enabled
required
boolean
email
Any of:

A single capability toggle within a PATCH /settings/agent-identity body.

object
enabled
required
boolean
phone
Any of:

A single capability toggle within a PATCH /settings/agent-identity body.

object
enabled
required
boolean
role
required
string

Responses

200

Successful Response

Response shape for PATCH /settings/agent-identity.

object
data
required
object
key
additional properties
any

422

Validation Error

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