Skip to main content
POST
Read tone examples

Authorizations

Authorization
string
header
required

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

Scopes

agents:read

Agents, runs, configuration, handbook, memory, tone examples, scheduled tasks, and connected-service research.

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
agentId
string
required

Agent whose account-specific tone examples to use.

Required string length: 1 - 64

Response

Success

examples
object[]
required
Maximum array length: 5