Skip to content
UltimateTeam.ai Docs

Toggle an agent identity capability

PATCH
/api/v1/settings/agent-identity
curl --request PATCH \
  --url https://api.ultimateteam.ai/api/v1/settings/agent-identity \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "card": { "enabled": true }, "email": { "enabled": true }, "phone": { "enabled": true }, "role": "example" }'

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

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
AgentIdentityPatchRequest

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:
AgentIdentityCapabilityPatch

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

object
enabled
required
Enabled
boolean
email
Any of:
AgentIdentityCapabilityPatch

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

object
enabled
required
Enabled
boolean
phone
Any of:
AgentIdentityCapabilityPatch

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

object
enabled
required
Enabled
boolean
role
required
Role
string
Examplegenerated
{
  "card": {
    "enabled": true
  },
  "email": {
    "enabled": true
  },
  "phone": {
    "enabled": true
  },
  "role": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
AgentIdentityPatchResponse

Response shape for PATCH /settings/agent-identity.

object
data
required
Data
object
key
additional properties
any
Examplegenerated
{
  "data": {}
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}