Create a chat intro. - Sudonum API

Creates one chat intro on the WhatsApp number you name in whatsapp_number. The number must belong to your organisation.

Templates. The three message templates carry {{ variable }} placeholders. Every variable you use must resolve, or the request is rejected. The platform supplies reference_id, intro_chat_link, intro_chat_shortcode, intro_chat_link_aparty, intro_chat_link_aparty_shortcode, from_whatsapp_number, to_whatsapp_number, agent_response_time and Link. You supply the rest through extra_variable_data. expected_message_template must use {{ reference_id }}.

Delays. reply_delay and notify_delay are seconds, from 1 to 600. reply_delay holds back the reply to the enquirer. notify_delay holds back the notification to the agent. Set both to the same value and the enquirer is still messaged first. Leave a delay out and that leg is sent without delay; the chat intro then reports it as 0.

Reply shape. reply_type selects what the enquirer receives. TEXT uses reply_message_template alone. IMAGE adds reply_message_file_url. INTERACTIVE adds reply_whatsapp_components and ignores reply_message_template.

Notification shape. notify_type selects how the agent is told, and each type reads a different set of notify_* fields. Omit notify_type and no notification is sent.

Request

Body Params application/json

Examples

Text reply held back 45 secondsBoth legs held back, enquirer firstReply held back the full 600 secondsNo delay on either leg

The enquirer's reply waits 45 seconds. No agent notification is configured, so notify_delay has nothing to hold back.

{
    "whatsapp_number": "27820000001",
    "reference_id": "REF-0001",
    "expected_message_template": "Hi, I am interested in {{ reference_id }}.",
    "reply_message_template": "Thanks for your interest in {{ reference_id }}. An agent will contact you shortly.",
    "intro_message_template": "New enquiry on {{ reference_id }} from {{ from_whatsapp_number }}.",
    "reply_delay": 45
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢201Created

application/json

The chat intro was created.

Bodyapplication/json

Example

{
    "uuid": "7b2e9d10-0000-4c00-8a00-2d3e4f5a6b7c",
    "whatsapp_number": "27820000001",
    "chat_link": "https://example.com/wa/abc123",
    "reference_id": "REF-0001",
    "expected_message_template": "Hi, I am interested in {{ reference_id }}.",
    "reply_message_template": "Thanks for your interest in {{ reference_id }}. An agent will contact you shortly.",
    "reply_message_file_url": null,
    "reply_type": "TEXT",
    "reply_data": {},
    "reply_alt_data": {},
    "intro_message_template": "New enquiry on {{ reference_id }} from {{ from_whatsapp_number }}.",
    "notify_type": null,
    "notify_data": {},
    "notify_delay": 0,
    "reply_delay": 45,
    "aparty_notify_data": {},
    "aparty_intro_data": {},
    "bparty_expiry_link": false,
    "extra_variable_data": {},
    "meta_data": {},
    "created": "2026-08-20T09:14:52.418000Z",
    "modified": "2026-08-20T09:14:52.418000Z"
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠429Too Many Requests