post
https://partner.gupshup.io/partner/app//v3/message
Use this API to send a media based message as template.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Note:
- Sending Marketing Templates through MM Lite for enhanced delivery optimization. For more details, refer to MM Lite document.
- Use the
recipientparameter only when BSUID is enabled for the app.- When both
toandrecipientfields are used in the payload, thetofield gets the priority.
Request Parameters
| Key | Value | Description | Data type | Required/Optional | Constraints |
|---|---|---|---|---|---|
| Authorization | {{PARTNER_APP_TOKEN}} | Access Token for the application | String | Required | Should be a valid Partner App Access Token. |
| appId | {{APP_ID}} | App ID to fetch the access token | String | Required | The ID should be a valid app Id of Gupshup. |
| messaging_product | Messaging product | String | Required | ||
| recipient_type | individual | Recipient type | String | Required | |
| to | 91785876xxxx | Destination phone number where the message needs to be sent | String | Required (Can be optional if BSUID is enabled for the app and recipient parameter is used instead) | Must be a valid phone number |
| recipient | IN.461449821882xxxx | Destination BSUID where the message needs to be sent | String | Optional | Must be a valid BSUID |
| type | template | Messaging type | String | Required | The type should be template to send a template message. |
| template | {<BODY>} | Template message inside body | Object | Required |
Sample Request
curl --location 'https://partner.gupshup.io/partner/app/{{APP_ID}}/v3/message' \
--header 'accept: application/json' \
--header 'Authorization: {{PARTNER_APP_TOKEN}}' \
--header 'Content-Type: application/json' \
--data '{
"messaging_product": "whatsapp",
"recipient_type": "individual",
"to": "PHONE_NUMBER",
"recipient": "BSUID",
"type": "template",
"template": {
"name": "TEMPLATE_NAME",
"language": {
"code": "LANGUAGE_AND_LOCALE_CODE"
},
"components": [
{
"type": "header",
"parameters": [
{
"type": "image",
"image": {
"link": "https://URL"
}
}
]
},
{
"type": "body",
"parameters": [
{
"type": "text",
"text": "TEXT-STRING"
},
{
"type": "currency",
"currency": {
"fallback_value": "VALUE",
"code": "USD",
"amount_1000": "NUMBER"
}
},
{
"type": "date_time",
"date_time": {
"fallback_value": "MONTH DAY, YEAR"
}
}
]
}
]
}Sample Response
{
"messages": [
{
"id": "GUPSHUP_MESSAGE_ID"
}
],
"messaging_product": "whatsapp",
"contacts": [
{
"input": "DESTINATION_PHONE_NO",
"wa_id": "DESTINATION_PHONE_NO"
}
]
}Status Codes
| Status Code | Response | Comments |
|---|---|---|
| Success | ||
| 200 | | |
| Error | ||
| 400 | | if Callback billing is not enabled for the app |
| 400 | | if app details are not found |
| 401 | | When API key authentication fails |