Create Chat Intro

POST

https://api.sudonum.com.com/v2/whatsapp/chat-intros/

This allows you to successfully attribute WhatsApp leads to a specific
online source (i.e. website, marketplace, marketing campaign, etc.).

Request

Header Params

Body Params application/json

Example

{
    "whatsapp_number": "{{whatsapp_number}}",
    "expected_message_template": "{{ reference_id }} {{Link}}",
    "reference_id": null,
    "reply_message_template": "Hi {{APartyDataContactName}}, Thank you for contacting {{AgencyName}} regarding {{PropertyName}} {{Link}}  For our agents to respond quickly please provide us with some extra information",
    "intro_message_template": "Hi there {{ AgentName }}, I'm {{APartyDataContactName}} one of the agents from {{AgencyName}}. Regarding your {{ PropertyName }}. Please let me know a good time to call. Link: {{Link}}",
    "notify_type": "WHATSAPP",
    "notify_to_phone_number": "{{destination_number}}",
    "notify_whatsapp_template_name": "-need-template-",
    "notify_whatsapp_template_components": [
        {  
            "type": "body",
            "parameters": [
                {"type": "text", "text": "{{AgentName}}"},
                {"type": "text", "text": "{{PropertyName}}"},
                {"type": "text", "text": "{{PropertyPrice}}"},
                {"type": "text", "text": "{{reference_id}}"}
            ]
        },
        {
            "type": "button",
            "sub_type": "url",
            "parameters": [
                {"type": "text", "text": "{{intro_chat_shortcode}}"}
            ]
        }
    ],
    "extra_variable_data": {
        "AgencyName": "AgencyName",
        "AgentName": "AgentName",
        "PropertyPrice": "30000",
        "Link": "http://www.sudonum.com",
        "APartyDataContactName": " ",
        "APartyDataContactPhonenumber": " ",
        "PropertyName": "123 fake street"
    },
    "meta_data": {
        "key1": "value1",
        "key2": "value2"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://api.sudonum.com.com/v2/whatsapp/chat-intros/' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data '{
    "whatsapp_number": "{{whatsapp_number}}",
    "expected_message_template": "{{ reference_id }} {{Link}}",
    "reference_id": null,
    "reply_message_template": "Hi {{APartyDataContactName}}, Thank you for contacting {{AgencyName}} regarding {{PropertyName}} {{Link}}  For our agents to respond quickly please provide us with some extra information",
    "intro_message_template": "Hi there {{ AgentName }}, I'\''m {{APartyDataContactName}} one of the agents from {{AgencyName}}. Regarding your {{ PropertyName }}. Please let me know a good time to call. Link: {{Link}}",
    "notify_type": "WHATSAPP",
    "notify_to_phone_number": "{{destination_number}}",
    "notify_whatsapp_template_name": "-need-template-",
    "notify_whatsapp_template_components": [
        {  
            "type": "body",
            "parameters": [
                {"type": "text", "text": "{{AgentName}}"},
                {"type": "text", "text": "{{PropertyName}}"},
                {"type": "text", "text": "{{PropertyPrice}}"},
                {"type": "text", "text": "{{reference_id}}"}
            ]
        },
        {
            "type": "button",
            "sub_type": "url",
            "parameters": [
                {"type": "text", "text": "{{intro_chat_shortcode}}"}
            ]
        }
    ],
    "extra_variable_data": {
        "AgencyName": "AgencyName",
        "AgentName": "AgentName",
        "PropertyPrice": "30000",
        "Link": "http://www.sudonum.com",
        "APartyDataContactName": " ",
        "APartyDataContactPhonenumber": " ",
        "PropertyName": "123 fake street"
    },
    "meta_data": {
        "key1": "value1",
        "key2": "value2"
    }
}'

Responses

🟢201

application/json

Bodyapplication/json

Example

{
    "uuid": "aute",
    "whatsapp_number": "dolor",
    "reference_id": "laboris in qui nos",
    "chat_link": "cupidatat quis",
    "expected_message_template": "est par",
    "reply_message_template": "in Lorem enim",
    "intro_message_template": "dolor nostrud",
    "notify_type": "amet dolor Excepteur",
    "notify_data": {
        "url": "do dolore",
        "from_phone_number": "anim Ut amet irure elit",
        "to_phone_number": "ipsum quis dolore Excepteur",
        "email": "cupidatat id incididunt nis",
        "message_template": "Lorem fugiat dolor dolor",
        "whatsapp_template_name": "enim sit",
        "whatsapp_template_components": [
            {
                "type": "body",
                "parameters": [
                    {
                        "type": "text",
                        "text": "{{extra_var_1}}"
                    },
                    {
                        "type": "text",
                        "text": "{{extra_var_2}}"
                    }
                ]
            },
            {
                "type": "button",
                "sub_type": "url",
                "parameters": [
                    {
                        "type": "text",
                        "text": "{{intro_chat_shortcode}}"
                    }
                ]
            }
        ]
    },
    "meta_data": {
        "key1": "value1",
        "key2": "value2"
    },
    "extra_variable_data": {
        "AgencyName": "AgencyName",
        "AgentName": "AgentName",
        "PropertyPrice": "30000",
        "Link": "http://www.sudonum.com",
        "APartyDataContactName": " ",
        "APartyDataContactPhonenumber": " ",
        "PropertyName": "123 fake street"
    },
    "created": "magna eu",
    "modified": "pariatur aute cupi"
}

Modified at 2026-08-31 07:42:46

All Chat Intros

Chat Intro Logs for a Chat Intro