Skip to main content
PATCH
Update an Agent's business and communication profile

Authorizations

Authorization
string
header
required

A Contact Button scoped bearer key. Send Authorization: Bearer <token>. Token abilities are enforced independently of workspace membership; both checks must pass. Interactive MCP clients use registered OAuth applications, Authorization Code + PKCE, audience-bound tokens, and explicit workspace grants. Personal Sanctum tokens remain supported.

Headers

Idempotency-Key
string

Stable 8–120 character key for safe mutation retries.

Required string length: 8 - 120

Path Parameters

workspace
string<uuid>
required
agent
string<uuid>
required

Body

application/json
business_name
string | null
Maximum string length: 120
industry
string | null
Maximum string length: 120
business_overview
string | null

Stable business context. Put changing facts such as prices, policies, and products in Knowledge.

Maximum string length: 2000
role
string | null
Maximum string length: 160
tone
enum<string>
Available options:
default,
friendly,
professional,
casual,
direct,
custom
custom_tone
string | null
Maximum string length: 500
answer_length
enum<string>
Available options:
default,
short,
medium,
detailed

Response

Successful data envelope.

data
any
required
meta
object
required