Skip to main content
POST
Save tone example

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Scopes

agents:write

Edit agent configuration, handbook, memory, tone examples, and schedules, and give agents tasks.

Body

application/json
connectedAccount
string
required

Exact connected-account selector used when searching or reading messages.

Minimum string length: 1
integrationType
enum<string>
required

Connected integration type from Connected Integrations. Use "aircall" for Aircall SMS and WhatsApp; "whatsapp" refers to the separate WhatsApp integration.

Available options:
slack,
whatsapp,
gmail,
aircall,
smily,
github,
zendesk,
hostaway,
outlook,
teams,
gorgias,
linear,
hubspot_conversations,
guesty,
hospitable,
trustpilot
example
string
required

One original message from the selected account, or one example message the user supplied verbatim for it. The backend removes identifying details while preserving its wording and meaning.

Required string length: 40 - 8000
agentId
string
required

Agent whose account-specific tone examples to use.

Required string length: 1 - 64

Response

Success

outcome
enum<string>
required
Available options:
saved,
duplicate,
rejected
rejectionReason
string