Aparty Template Components

POST

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

Allow APARTY to directly connect with a click out to the BPARTY

Variation Description

intro_message_aparty: Supply a message the APARTY wishes to use when connecting directly to the BPARTY

intro_bparty_number: Supply the destination number that the APARTY will connect to directly, in cases where the BPARTY has not reach out yet

{{intro_chat_link_aparty}} becomes available to interactive cta_url button clickouts

Request

Header Params

Body Params application/json

Example

{
    "whatsapp_number": "{{whatsapp_number}}",
    "expected_message_template": "laborum nisi ad aliquip {{ reference_id }}",
    "reference_id": null,
    "reply_message_template": "laborum nisi ad aliquip  {{APartyDataContactName}}, laborum nisi ad aliquip  {{AgencyName}} lorem {{PropertyName}} {{Link}}  laborum nisi ad aliquip ",
    "intro_message_template": "laborum nisi ad aliquip {{ AgentName }}, laborum nisi ad aliquip  {{ PropertyName }}. laborum nisi ad aliquip  {{Link}}",
    "reply_type": "TEXT",
    "aparty_notify_whatsapp_template_name": "-need-template-",
    "aparty_notify_whatsapp_template_components": [
        {
            "type": "header",
            "parameters": [
                {
                    "type": "image",
                    "image": {
                        "url": "link.to.image"
                    }
                }
            ]
        },
        {  
            "type": "body",
            "parameters": [
                {"type": "text", "text": "{{AgencyName}}"},
                {"type": "text", "text": "{{AgentName}}"}
            ]
        }
    ],
    "notify_type": "WHATSAPP",
    "notify_to_phone_number": "{{destination_number}}",
    "notify_whatsapp_template_name": "-needs-template-",
    "notify_whatsapp_template_components": [
        {  
            "type": "body",
            "parameters": [
                {"type": "text", "text": "{{APartyDataContactName}}"}, 
                {"type": "text", "text": "{{PropertyName}}"}, 
                {"type": "text", "text": "{{PropertyPrice}}"}, 
                {"type": "text", "text": "{{reference_id}}"},
                {"type": "text", "text": "{{Link}}"}
            ]
        },
        {
            "type": "header",
            "parameters": [
                    {
                        "type": "image",
                        "image": {
                            "url": "http://link.to.image.jpg"
                        }
                    }
            ]
        },
        {  
            "type": "button",
            "sub_type": "url",
            "parameters": [
                {"type": "text", "text": "{{intro_chat_shortcode}}"}
            ]
        }
    ],
    "extra_variable_data": { 
        "AgencyName":" AgentName",
        "AgentName": "AgentName",
        "PropertyPrice": "0000000",
        "Link": "www.website.com",
        "APartyDataContactName": " ",
        "APartyDataContactPhonenumber": " ",
        "PropertyName": "123 fake street"
    }
}

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 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
    "whatsapp_number": "{{whatsapp_number}}",
    "expected_message_template": "laborum nisi ad aliquip {{ reference_id }}",
    "reference_id": null,
    "reply_message_template": "laborum nisi ad aliquip  {{APartyDataContactName}}, laborum nisi ad aliquip  {{AgencyName}} lorem {{PropertyName}} {{Link}}  laborum nisi ad aliquip ",
    "intro_message_template": "laborum nisi ad aliquip {{ AgentName }}, laborum nisi ad aliquip  {{ PropertyName }}. laborum nisi ad aliquip  {{Link}}",
    "reply_type": "TEXT",
    "aparty_notify_whatsapp_template_name": "-need-template-",
    "aparty_notify_whatsapp_template_components": [
        {
            "type": "header",
            "parameters": [
                {
                    "type": "image",
                    "image": {
                        "url": "link.to.image"
                    }
                }
            ]
        },
        {  
            "type": "body",
            "parameters": [
                {"type": "text", "text": "{{AgencyName}}"},
                {"type": "text", "text": "{{AgentName}}"}
            ]
        }
    ],
    "notify_type": "WHATSAPP",
    "notify_to_phone_number": "{{destination_number}}",
    "notify_whatsapp_template_name": "-needs-template-",
    "notify_whatsapp_template_components": [
        {  
            "type": "body",
            "parameters": [
                {"type": "text", "text": "{{APartyDataContactName}}"}, 
                {"type": "text", "text": "{{PropertyName}}"}, 
                {"type": "text", "text": "{{PropertyPrice}}"}, 
                {"type": "text", "text": "{{reference_id}}"},
                {"type": "text", "text": "{{Link}}"}
            ]
        },
        {
            "type": "header",
            "parameters": [
                    {
                        "type": "image",
                        "image": {
                            "url": "http://link.to.image.jpg"
                        }
                    }
            ]
        },
        {  
            "type": "button",
            "sub_type": "url",
            "parameters": [
                {"type": "text", "text": "{{intro_chat_shortcode}}"}
            ]
        }
    ],
    "extra_variable_data": { 
        "AgencyName":" AgentName",
        "AgentName": "AgentName",
        "PropertyPrice": "0000000",
        "Link": "www.website.com",
        "APartyDataContactName": " ",
        "APartyDataContactPhonenumber": " ",
        "PropertyName": "123 fake street"
    }
}'

Responses

🟢201

application/json

Bodyapplication/json

Example

{
    "uuid": "03bebf03-...",
    "whatsapp_number": "<whatsapp_id>",
    "chat_link": "../l/M9cDcJTpoS",
    "reference_id": null,
    "expected_message_template": "laborum nisi ad aliquip {{ reference_id }}",
    "reply_message_template": "laborum nisi ad aliquip  {{APartyDataContactName}}, laborum nisi ad aliquip  {{AgencyName}} lorem {{PropertyName}} {{Link}}  laborum nisi ad aliquip",
    "reply_message_file_url": null,
    "reply_type": "TEXT",
    "intro_message_template": "laborum nisi ad aliquip {{ AgentName }}, laborum nisi ad aliquip  {{ PropertyName }}. laborum nisi ad aliquip  {{Link}}",
    "notify_type": "WHATSAPP",
    "notify_data": {
        "to_phone_number": "<destination_id>",
        "whatsapp_template_name": "template_to_seller",
        "whatsapp_template_params": [],
        "whatsapp_template_components": [
            {
                "type": "body",
                "parameters": [
                    {
                        "type": "text",
                        "text": "{{APartyDataContactName}}"
                    },
                    {
                        "type": "text",
                        "text": "{{PropertyName}}"
                    },
                    {
                        "type": "text",
                        "text": "{{PropertyPrice}}"
                    },
                    {
                        "type": "text",
                        "text": "{{reference_id}}"
                    },
                    {
                        "type": "text",
                        "text": "{{Link}}"
                    }
                ]
            },
            {
                "type": "header",
                "parameters": [
                    {
                        "type": "image",
                        "image": {
                            "url": "http://link.to.image.jpg"
                        }
                    }
                ]
            },
            {
                "type": "button",
                "sub_type": "url",
                "parameters": [
                    {
                        "type": "text",
                        "text": "{{intro_chat_shortcode}}"
                    }
                ]
            }
        ]
    },
    "aparty_notify_data": {
        "whatsapp_template_name": "-needs-template-",
        "whatsapp_template_components": [
            {
                "type": "header",
                "parameters": [
                    {
                        "type": "image",
                        "image": {
                            "url": "link.to.image"
                        }
                    }
                ]
            },
            {
                "type": "body",
                "parameters": [
                    {
                        "type": "text",
                        "text": "{{AgencyName}}"
                    },
                    {
                        "type": "text",
                        "text": "{{AgentName}}"
                    }
                ]
            }
        ]
    },
    "aparty_intro_data": {},
    "bparty_expiry_link": false,
    "extra_variable_data": {
        "AgencyName": "AgencyName",
        "AgentName": "AgentName",
        "PropertyPrice": "30000",
        "Link": "www.sudonum.com",
        "APartyDataContactName": "",
        "APartyDataContactPhonenumber": "",
        "PropertyName": "123 fake street"
    },
    "meta_data": {},
    "created": "2025-06-27T08:32:04.773548Z",
    "modified": "2025-06-27T08:32:04.792763Z"
}

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

Aparty notify Flow template

Aparty Template Components + Aparty connect