Authentication-based Message Templates

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	whatsapp	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	Must be a valid phone number
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": "<CUSTOMER_PHONE_NUMBER>",
    "type": "template",
    "template": {
    		"name": "<TEMPLATE_NAME>",
        "language": {
        		"code": "<TEMPLATE_LANGUAGE_CODE>"
				},
				"components": [
						{
            		"type": "body",
                "parameters": [
                		{
                    		"type": "text",
                        "text": "<ONE-TIME PASSWORD>"
                    }
								]
						},
						{
            		"type": "button",
                "sub_type": "url",
                "index": "0",
                "parameters": [
										{
                    		"type": "text",
                        "text": "<ONE-TIME PASSWORD>"
                    }
                ]
            }
        ]
	}
}'

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	`{ "messages": [ { "id": "GUPSHUP_MESSAGE_ID" } ], "messaging_product": "whatsapp", "contacts": [ { "input": "DESTINATION_PHONE_NO", "wa_id": "DESTINATION_PHONE_NO" } ] }`
Error
400	`{ "message": "Callback Billing must be enabled for this API", "status": "error" }`	If callback billing is not enabled for the app
400	`{ "message": "Invalid App Details", "status": "error" }`	if app details are not found
401	`{ "status": "error", "message": "Authentication Failed" }`	When API key authentication fails