Skip to main content
POST
Respond to Interactive Tool as a contact on a channel

Authorizations

Authorization
string
header
required

Bearer token authentication using your API key

Path Parameters

org_id
string
required

Org ID

contact_id
string
required

Contact ID

channel_id
string
required

Channel ID

chat_id
string
required

Chat ID

message_id
string
required

The ID of the message with the pending tool.

tool_call_id
string
required

The ID of the tool call being responded to.

Body

A user response to an interactive tool, discriminated by response type.

type
enum<string>
required
Available options:
connection
connection_id
string

The connected connection id (con_...). Omit when declining an app.

declined_type
enum<string>

The app the person will not connect; its request resolves without a connection.

Available options:
SCHEDULER,
WORKFLOWS,
TOOLS,
FILES,
EMAILS,
HTTP_CREDENTIALS,
TABLES,
PAGES,
KNOWLEDGE,
SKILLS,
CONTACTS,
SEGMENTS,
ASSISTANTS,
AGENTS,
CHATS,
INBOX,
MEMBERS,
BROADCASTS,
ANALYTICS,
AUDIT,
PHONE,
GMAIL,
GOOGLE_SHEETS,
GOOGLE_CALENDAR,
GOOGLE_DRIVE,
OUTLOOK_CALENDAR,
AIRTABLE,
NOTION,
LINEAR,
HUBSPOT,
GOHIGHLEVEL,
CAL,
CALENDLY,
RESEND,
OAUTH,
SLACK,
TELEGRAM,
TRELLO,
FACEBOOK,
WHATSAPP,
INSTAGRAM,
MESSENGER,
TIKTOK,
JAPIFON,
SMPP,
TWILIO,
TELNYX,
ZOHO,
ZOHO_BOOKINGS,
ZOHO_INVENTORY,
ZOHO_CALENDAR,
SALESFORCE,
STRIPE,
SHOPIFY,
ZENDESK,
MCP,
OPENAPI,
ODOO,
WOOCOMMERCE
Example:

"SLACK"

Response

200 - application/json

The chat message schema

id
string
required
role
enum<string>
required

The role of the message

Available options:
user,
assistant,
system,
tool,
event,
note
model
string
required

The model used for the message

status
enum<string>
required

The chat status

Available options:
RUNNING,
COMPLETED,
FAILED,
CANCELED
created_at
string<date-time> | null
required
updated_at
string<date-time> | null
required
messages
object[]

The message content

System message

member
object

The member of the chat

error
string

Error message if the message failed

broadcast_id
string

ID of the broadcast this message originates from

is_broadcast_message
boolean

Whether this message was sent via a broadcast template

usage
object

The usage information for the message

delivered_at
string<date-time> | null

When the message was delivered to the recipient

reactions
object[]

Emoji reactions on the message