Skip to main content
PATCH
/
api
/
v1
/
admin
/
agents
/
{agent_id}
/
state
Set Agent State
curl --request PATCH \
  --url https://api.example.com/api/v1/admin/agents/{agent_id}/state \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "note": "<string>"
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
agent_id
string<uuid>
required

Body

application/json

Change visibility state of a single agent/team.

​
state
enum<string>
required
Available options:
draft,
coming_soon,
beta,
live,
hidden
​
note
string | null
Maximum string length: 500

Response

Successful Response