Skip to main content
PATCH
Update an Agent

Authorizations

Authorization
string
header
required

Organization-scoped Auth0 user access token issued to an approved first-party client or exchanged by a trusted OBO resource server.

Path Parameters

id
string
required

Opaque Arbol resource identifier; the endpoint and tenant-scoped lookup determine its resource type.

Maximum string length: 64
Pattern: ^[a-z][a-z0-9]{1,15}_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Example:

"agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31"

Body

application/json
description
string | null
Maximum string length: 2000
knowledgeDocumentIds
string[]
Maximum array length: 100

Opaque Arbol resource identifier; the endpoint and tenant-scoped lookup determine its resource type.

Maximum string length: 64
Pattern: ^[a-z][a-z0-9]{1,15}_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
language
string
Required string length: 2 - 16
name
string

Customer-visible name of an Agent.

Required string length: 1 - 120
Example:

"Asistente de ventas"

profiles
Agent profile input · object[]
Maximum array length: 3

Complete desired settings for one channel-specific Agent profile.

prompt
string | null
Maximum string length: 32000
timezone
string | null

Canonical IANA timezone name.

Required string length: 1 - 120
Example:

"America/Bogota"

toolAccess
Tool access · object[]

Complete account-qualified desired tool access, replaced atomically as one revision.

Maximum array length: 50
expectedToolAccessRevision
integer
Required range: 0 <= x <= 9007199254740991
status
enum<string>

Customer-controlled lifecycle state of an Agent.

Available options:
active,
paused
Example:

"active"

Response

OK

createdAt
string<date-time>
required

ISO 8601 timestamp with an explicit UTC offset.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
Example:

"2026-08-29T14:30:00Z"

description
string | null
required
Maximum string length: 2000
id
string
required

Opaque Arbol resource identifier; the endpoint and tenant-scoped lookup determine its resource type.

Maximum string length: 64
Pattern: ^[a-z][a-z0-9]{1,15}_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Example:

"agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31"

kind
enum<string>
required

Runtime family implemented by an Agent.

Available options:
voice,
messaging,
email,
internal
Example:

"voice"

language
string
required
Required string length: 2 - 16
name
string
required

Customer-visible name of an Agent.

Required string length: 1 - 120
Example:

"Asistente de ventas"

prompt
string | null
required
Maximum string length: 32000
status
enum<string>
required

Customer-controlled lifecycle state of an Agent.

Available options:
active,
paused
Example:

"active"

supportedChannelKinds
enum<string>[]
required
Maximum array length: 6

Conversation transport family.

Available options:
voice,
whatsapp,
telegram,
slack,
email,
web
timezone
string | null
required

Canonical IANA timezone name.

Required string length: 1 - 120
Example:

"America/Bogota"

updatedAt
string<date-time>
required

ISO 8601 timestamp with an explicit UTC offset.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
Example:

"2026-08-29T14:30:00Z"

isRunnable
boolean
required
knowledgeDocumentIds
string[]
Maximum array length: 100

Opaque Arbol resource identifier; the endpoint and tenant-scoped lookup determine its resource type.

Maximum string length: 64
Pattern: ^[a-z][a-z0-9]{1,15}_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
profiles
Agent profile · object[]
Maximum array length: 3

Persisted channel-specific Agent profile and its provider runtime state.

toolAccess
object