Send Carousel Message Template

POST

https://api.sudonum.com.com/v2/whatsapp/messages/

This allows you to send a Carousel Media Message Template from your WhatsApp number.

Note: Exclusive only to Meta Whatsapp Accounts and follows all the validation rules set by META (see link below)

See: https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates/media-card-carousel-templates

Request

Header Params

Body Params application/json

Example

{
    "whatsapp_number": "{{whatsapp_number}}",
    "type": "TEMPLATE",
    "to_whatsapp_number": "{{destination_number}}",
    "template": {
        "template_name": "-template-name-",
        "components": [
             {
                "type": "body",
                "parameters": [
                    {
                    "text": "Enquirer's Name",
                    "type": "text"
                }
                ]
            },
            {
                "type": "carousel",
                "cards": [
                    {
                        "card_index": 0,
                        "components": [
                            {
                                "type": "header",
                                "parameters": [
                                    {
                                        "type": "image",
                                        "image": {
                                            "url": "https://url.to.image.jpg"
                                        }
                                    }
                                ]
                            },
                            {
                                "type": "body",
                                "parameters": [
                                    {
                                        "text": "Property Name",
                                        "type": "text"
                                    },
                                    {
                                        "text": "$55000",
                                        "type": "text"
                                    }
                                ]
                            },
                            {
                                "type": "button",
                                "sub_type": "quick_reply",
                                "index": "0",
                                "parameters": [
                                    {
                                        "type": "payload",
                                        "payload": "-reference-id-"
                                    }
                                ]
                            },
                            {
                                "type": "button",
                                "sub_type": "url",
                                "index": "1",
                                "parameters": [
                                    {
                                        "type": "payload",
                                        "payload": "-link-to-property"
                                    }
                                ]
                            }
                        ]
                    }
                    // .... more cards, remember to step the "card_index"
                ]
            }
        ]
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://api.sudonum.com.com/v2/whatsapp/messages/' \
--header 'Content-Type: application/json' \
--data '{
    "whatsapp_number": "{{whatsapp_number}}",
    "type": "TEMPLATE",
    "to_whatsapp_number": "{{destination_number}}",
    "template": {
        "template_name": "-template-name-",
        "components": [
             {
                "type": "body",
                "parameters": [
                    {
                    "text": "Enquirer'\''s Name",
                    "type": "text"
                }
                ]
            },
            {
                "type": "carousel",
                "cards": [
                    {
                        "card_index": 0,
                        "components": [
                            {
                                "type": "header",
                                "parameters": [
                                    {
                                        "type": "image",
                                        "image": {
                                            "url": "https://url.to.image.jpg"
                                        }
                                    }
                                ]
                            },
                            {
                                "type": "body",
                                "parameters": [
                                    {
                                        "text": "Property Name",
                                        "type": "text"
                                    },
                                    {
                                        "text": "$55000",
                                        "type": "text"
                                    }
                                ]
                            },
                            {
                                "type": "button",
                                "sub_type": "quick_reply",
                                "index": "0",
                                "parameters": [
                                    {
                                        "type": "payload",
                                        "payload": "-reference-id-"
                                    }
                                ]
                            },
                            {
                                "type": "button",
                                "sub_type": "url",
                                "index": "1",
                                "parameters": [
                                    {
                                        "type": "payload",
                                        "payload": "-link-to-property"
                                    }
                                ]
                            }
                        ]
                    }
                    // .... more cards, remember to step the "card_index"
                ]
            }
        ]
    }
}'

Responses

🟢201

application/json

Bodyapplication/json

Example

{
    "uuid": "4bdada52-b39c-4054-bf34-22bae66c31ff",
    "type": "TEMPLATE",
    "status": "QUEUED",
    "status_description": "",
    "whatsapp_number": "<WHATSAPP_ACCOUNT>",
    "direction": "OUTBOUND",
    "from_whatsapp_number": "<WHATSAPP_ACCOUNT>",
    "to_whatsapp_number": "<DESTINATION_NUMBER>",
    "message_data": {
        "template_name": "<CAROUSEL TEMPLATE NAME>",
        "components": [
             {
                "type": "body",
                "parameters": [
                    {
                    "text": "Enquirer's Name",
                    "type": "text"
                }
                ]
            },
            {
                "type": "carousel",
                "cards": [
                    {
                        "card_index": 0,
                        "components": [
                            {
                                "type": "header",
                                "parameters": [
                                    {
                                        "type": "image",
                                        "image": {
                                            "url": "https://url.to.image.jpg"
                                        }
                                    }
                                ]
                            },
                            {
                                "type": "body",
                                "parameters": [
                                    {
                                        "text": "Property Name",
                                        "type": "text"
                                    },
                                    {
                                        "text": "$55000",
                                        "type": "text"
                                    }
                                ]
                            },
                            {
                                "type": "button",
                                "sub_type": "quick_reply",
                                "index": "0",
                                "parameters": [
                                    {
                                        "type": "payload",
                                        "payload": "-reference-id-"
                                    }
                                ]
                            },
                            {
                                "type": "button",
                                "sub_type": "url",
                                "index": "1",
                                "parameters": [
                                    {
                                        "type": "payload",
                                        "payload": "-link-to-property"
                                    }
                                ]
                            }
                        ]
                    }
                ]
            }
        ]
    },
    "meta_data": {},
    "context_data": {},
    "created": "2024-06-28T13:55:08.043613Z",
    "modified": "2024-06-28T13:55:08.050863Z"
}

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

Send LTO Coupon (WITH expiry date)

Send OTP Template