Location-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	`{ "type": "header", "parameters": [ { "type": "location", "location": { "latitude": "<LATITUDE>", "longitude": "<LONGITUDE>", "name": "<NAME>", "address": "<ADDRESS>" } } ] }`	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 'Content-Type: application/json' \
--header 'Authorization: {{PARTNER_APP_TOKEN}}' \
--data '{
	"messaging_product": "whatsapp",
	"recipient_type": "individual",
	"to": "12245554792",
	"type": "template",
	"template": {
		"name": "order_delivery_update",
		"language": {
			"code": "en_US"
		},
		"components": [
			{
				"type": "header",
				"parameters": [
					{
						"type": "location",
						"location": {
							"latitude": "37.483307",
							"longitude": "122.148981",
							"name": "Pablo Morales",
							"address": "Hacker Way, Menlo Park, CA 94025"
						}
					}
				]
			},
			{
				"type": "body",
				"parameters": [
					{
						"type": "text",
						"text": "Pablo"
					},
					{
						"type": "text",
						"text": "566701"
					}
				]
			}
		]
	}
}'

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