Skip to main content
These endpoints are for the VIP plan only. Other plans get a 403. See Plan access.
An action is something the agent can do during a conversation, like book a meeting or send a text. Each kind has the same five endpoints. Replace {kind} with calendar, transfer, sms, email, whatsapp or slack. Every action has name (required when you create one), condition (when the agent should use it) and isActive. The fields for each kind are below. The API checks the same rules as the dashboard’s server.

​
Calendar

​
string
required
cal_com, calendly, leadconnector or google. The provider must be connected in the dashboard.
​
string
A calendar or event type id from List calendars.
​
string
An IANA time zone like America/New_York. Leave it out and the agent asks the contact.
A calendar action also adds booking steps to the agent’s prompt, the same as in the dashboard.

​
Transfer

Transfer actions work on voice agents only, the same as in the dashboard. A chat or widget agent gets a 400.
​
string
required
warm (the agent introduces the caller first) or cold (it hands the call straight over).
​
string
required
The number to transfer to, in E.164 format like +14155551234.
​
string
required
What the agent says before it transfers. On an update you may leave it out, but you can’t set it to empty.

​
SMS and WhatsApp

​
string
required
The number to send from. It must be a number in the agent’s workspace.
​
string
contact sends to the person in the conversation, specific sends to recipientValue, and ask lets the agent ask. Leave it out for contact.
​
string
The number to send to. Needed when recipientType is specific.
​
string
required
The message. It can use {{variables}} from parameters. Required for SMS. WhatsApp needs it too, since fixed is the only message mode today.
​
object[]
Values the agent fills in from the conversation.

​
Email

​
string
required
The sender name.
​
string
required
The part of the sender address before the @, like support.
​
string
required
The subject line.
​
string
required
The plain text body.
​
string
The HTML body.
​
string
required
contact, specific or ask, as above.
​
string
The address to send to. Needed when recipientType is specific.
​
string
A sender address in the workspace. Leave it out to use the default.

​
Slack

​
string
required
The Slack channel to post in. Slack must be connected in the dashboard.
​
string
The channel’s name, for display.
​
string
required
The message.

​
Response

Each action comes back with its id, kind, agentId, its fields, createdAt and updatedAt.
Response

​
Errors