Skip to main content

DialogueCreate

Low-level payload to create a dialogue record directly. Most dialogues are created automatically by the platform when a message is received or outreach is sent; use this only for advanced/manual scenarios.

product_idProduct Idrequired

ID of the product (workspace) that owns this record. Most endpoints scope access by product.

agent_idAgent Idrequired

ID of the agent (a configured AI assistant / bot persona) this record belongs to.

contact_idContact Idrequired

ID of the contact this record relates to.

channel_idChannel Idrequired

ID of the messaging channel this record relates to.

stageStage

Initial dialogue stage; defaults to "initial".

Possible values: [initial, attempted, started, ongoing, pending, failed, redirected, finished, refused, success, disqualified, escalated]

Default value: initial
chat_idChat Idrequired

The channel-specific chat identifier to bind the dialogue to.

last_user_msg_id object
anyOf
integer
last_user_msg_at object
anyOf
date-time
last_bot_msg_id object
anyOf
integer
is_mainIs Main

Whether this dialogue is the primary one for the agent/contact pair. Defaults to true.

Default value: true
bot_mutedBot Muted

Whether the bot starts muted in this dialogue.

Default value: false
pending_until object
anyOf
date-time
pending_type object
anyOf
PendingType

Possible values: [follow_up, human_clarification, n8n_async_tool, custom_follow_up, future_meeting]

pending_ref object
anyOf
string
started_at object
anyOf
date-time
ext_id object
anyOf
string
waba_opener_sent_after_window_num object
anyOf
integer
is_sub_outreachIs Sub Outreach
Default value: false
warmup_pair_id object
anyOf
integer
is_incomingIs Incoming
Default value: false
is_group_chatIs Group Chat
Default value: false
skip_response_for_user_msg_id object
anyOf
integer
skip_response_until object
anyOf
date-time
last_tree_node_id object
anyOf
integer
subject object
anyOf
string
DialogueCreate
{
  "product_id": 0,
  "agent_id": 0,
  "contact_id": 0,
  "channel_id": 0,
  "stage": "initial",
  "chat_id": "string",
  "last_user_msg_id": 0,
  "last_user_msg_at": "2024-07-29T15:51:28.071Z",
  "last_bot_msg_id": 0,
  "is_main": true,
  "bot_muted": false,
  "pending_until": "2024-07-29T15:51:28.071Z",
  "pending_type": "follow_up",
  "pending_ref": "string",
  "started_at": "2024-07-29T15:51:28.071Z",
  "ext_id": "string",
  "waba_opener_sent_after_window_num": 0,
  "is_sub_outreach": false,
  "warmup_pair_id": 0,
  "is_incoming": false,
  "is_group_chat": false,
  "skip_response_for_user_msg_id": 0,
  "skip_response_until": "2024-07-29T15:51:28.071Z",
  "last_tree_node_id": 0,
  "subject": "string"
}