Sendzen API Documentation
HomeGetting StartedChangelog
HomeGetting StartedChangelog
Visit Website
Sign In
Create an account
    • Start Guide
      • Getting Started
      • API Reference
    • Messages
      • Template Messages
        • Send Text Message
        • Send Interactive Message
        • Send Media Message
      • Session Messages
        • Send Text Message
        • Send Image Message
        • Send Video Message
        • Send Audio Message
        • Send Document Message
        • Send Interactive Reply Message
      • Incoming Messages
        • Received Text Message
        • Received Message with Reaction
        • Received Media Message with Image
        • Received Callback from a Quick Reply Button Click
      • Other
        • Message Status & Typing Indicator
    • Template
      • List Templates
      • Create Template
      • Delete Template
      • Upload Media
    • Partner
      • Integration Guide
    • Project
      • Create Project
      • List Projects
      • Update Project
      • Retrieve Project
    • WABA
      • List WABA
      • Retrieve WABA Details from Meta
      • Retrieve WhatsApp Business Profile Detail
      • Update WhatsApp Business Profile
      • Upload WhatsApp Business Profile
    • Activity Logs
      • All Event Logs
      • Incoming Message Logs
      • Message Status Logs
      • Other Event Logs
      • Multiple Event Types
    • Knowledge Base
      • Programming Languages
        • Python
        • Node.js
        • PHP
        • Laravel
        • Java
        • C# .NET
      • Onboarding
        • WhatsApp Setup
      • Product
        • Changelog
    • Schemas
      • Schemas
        • Template Message
        • 401/403 Message Response
        • AccountLoginRequest
        • APIKeyDto
        • ReadTypingIndicatorRequest
        • AccountRegisterRequest
        • TypingIndicator
        • PartnerConfigDto
        • LoginResponse
        • PartnerInfoDto
        • WABASignUp
        • OrderCheckoutDto
        • OrderDto
        • OrderStatusEnum
        • PaymentGatewayDto
      • Knowledge Base
      • Address
      • Account
      • CommonResponse
      • AccountDetailDto
      • CreateOrUpdateProjectRequest
      • Contact
      • Error
      • ContactName
      • Button
      • ErrorResponse
      • CarouselCard
      • Email
      • ClientData
      • Component
      • ProjectDetailDto
      • ProjectWABADetail
      • Interactive
      • WABADetail
      • InteractiveAction
      • WABADto
      • InteractiveBody
      • CreateTemplateRequest
      • InteractiveButton
      • InteractiveFooter
      • CreateWebhookConfigRequest
      • InteractiveHeader
      • InteractiveMedia
      • Example
      • InteractiveProductItem
      • InteractiveProductSection
      • InteractiveReply
      • InteractiveRow
      • InteractiveSection
      • Location
      • Media
      • MessageRequest
      • MessageResponse
      • MessageTemplate
      • Organization
      • LimitedTimeOffer
      • Phone
      • Reaction
      • Response
      • TemplateAction
      • NamedParameter
      • TemplateButtons
      • TemplateCarousel
      • TemplateComponent
      • TemplateCurrency
      • PaginatedWebhookLogsResponse
      • TemplateDateTime
      • PartnerClientSession
      • TemplateLimitedTimeOffer
      • PartnerClientSessionDto
      • TemplateMedia
      • TemplateParameter
      • TemplateProductItem
      • TemplateSection
      • TemplateTapTargetConfiguration
      • SupportedApp
      • Text
      • Url
      • WhatsAppBusinessProfile
      • UploadMedia
      • Webhook
      • WebhookConfigDto
      • WebhookLogDto

    MessageRequest

    {
        "from": "string",
        "to": "string",
        "type": "string",
        "template": {
            "name": "string",
            "lang_code": "string",
            "components": [
                {
                    "type": "string",
                    "parameters": [
                        {
                            "type": "string",
                            "text": "string",
                            "currency": {
                                "fallback_value": "string",
                                "code": "string",
                                "amount_1000": 0
                            },
                            "date_time": {
                                "fallback_value": "string"
                            },
                            "image": {
                                "id": "string",
                                "link": "string",
                                "filename": "string"
                            },
                            "video": {
                                "id": "string",
                                "link": "string",
                                "filename": "string"
                            },
                            "document": {
                                "id": "string",
                                "link": "string",
                                "filename": "string"
                            },
                            "payload": "string",
                            "coupon_code": "string",
                            "action": {
                                "flow_token": "string",
                                "flow_action_data": null,
                                "thumbnail_product_retailer_id": "string",
                                "sections": [
                                    {
                                        "title": "string",
                                        "product_items": [
                                            {
                                                "product_retailer_id": "string",
                                                "catalog_id": "string"
                                            }
                                        ]
                                    }
                                ]
                            },
                            "product": {
                                "product_retailer_id": "string",
                                "catalog_id": "string"
                            },
                            "tap_target_configuration": [
                                {
                                    "url": "string",
                                    "title": "string"
                                }
                            ],
                            "limited_time_offer": {
                                "expiration_time_ms": 0
                            }
                        }
                    ],
                    "cards": [
                        {
                            "card_index": 0,
                            "components": [
                                {}
                            ]
                        }
                    ],
                    "sub_type": "string",
                    "index": 0,
                    "buttons": [
                        {
                            "type": "string",
                            "text": "string",
                            "flow_id": "string",
                            "flow_name": "string",
                            "flow_action": "string",
                            "navigate_screen": "string",
                            "flow_json": "string",
                            "icon": "string"
                        }
                    ]
                }
            ]
        },
        "text": {
            "body": "string",
            "preview_url": true
        },
        "reaction": {
            "message_id": "string",
            "emoji": "string"
        },
        "image": {
            "id": "string",
            "link": "string",
            "caption": "string",
            "filename": "string",
            "provider": "string"
        },
        "audio": {
            "id": "string",
            "link": "string",
            "caption": "string",
            "filename": "string",
            "provider": "string"
        },
        "video": {
            "id": "string",
            "link": "string",
            "caption": "string",
            "filename": "string",
            "provider": "string"
        },
        "document": {
            "id": "string",
            "link": "string",
            "caption": "string",
            "filename": "string",
            "provider": "string"
        },
        "sticker": {
            "id": "string",
            "link": "string",
            "caption": "string",
            "filename": "string",
            "provider": "string"
        },
        "location": {
            "longitude": "string",
            "latitude": "string",
            "name": "string",
            "address": "string"
        },
        "interactive": {
            "type": "string",
            "header": {
                "type": "string",
                "text": "string",
                "image": {
                    "link": "string",
                    "id": "string",
                    "caption": "string"
                },
                "video": {
                    "link": "string",
                    "id": "string",
                    "caption": "string"
                },
                "document": {
                    "link": "string",
                    "id": "string",
                    "caption": "string"
                }
            },
            "body": {
                "text": "string"
            },
            "footer": {
                "text": "string"
            },
            "action": {
                "buttons": [
                    {
                        "type": "string",
                        "reply": {
                            "id": "string",
                            "title": "string"
                        }
                    }
                ],
                "button": "string",
                "section": [
                    {
                        "title": "string",
                        "rows": [
                            {
                                "id": "string",
                                "title": "string",
                                "description": "string"
                            }
                        ]
                    }
                ],
                "catalog_id": "string",
                "product_retailer_id": "string",
                "sections": [
                    {
                        "title": "string",
                        "product_items": [
                            {
                                "product_retailer_id": "string"
                            }
                        ]
                    }
                ]
            }
        },
        "contacts": [
            {
                "addresses": [
                    {
                        "street": "string",
                        "city": "string",
                        "state": "string",
                        "zip": "string",
                        "country": "string",
                        "country_code": "string",
                        "type": "string"
                    }
                ],
                "birthday": "string",
                "emails": [
                    {
                        "email": "string",
                        "type": "string"
                    }
                ],
                "name": {
                    "formatted_name": "string",
                    "first_name": "string",
                    "last_name": "string",
                    "middle_name": "string",
                    "suffix": "string",
                    "prefix": "string"
                },
                "org": {
                    "company": "string",
                    "department": "string",
                    "title": "string"
                },
                "phones": [
                    {
                        "phone": "string",
                        "type": "string",
                        "wa_id": "string"
                    }
                ],
                "urls": [
                    {
                        "url": "string",
                        "type": "string"
                    }
                ]
            }
        ],
        "campaign_name": "string",
        "callback_data": "string",
        "schedule_time": "string",
        "is_inbox": true
    }
    Built with