Request Parameters

Key	Description	Values	Data Type	Required/Optional	Constraints
Headers
Authorisation	Access Token for the application	sk_8eb35b1f81c24af2xxxxxx	String	Required	Should be a valid Partner App Access Token.
Path Params
App Id	App ID to fetch the access token	bf9ee64c-3d4d-4ac4-xxxx-732e577007c4	String	Required	The Id should be a valid app Id of Gupshup
Body JSON
messaging_product	Messaging product	whatsapp	String	Required
recipient_type	Recipient type	individual	String	Required
to	Destination phone no where the message need to be send	91785876xxxx	String	Required	Must be a valid phone number.
type	Messaging type	interactive	String	Required	Type should be interactive to send interactive message.
interactive	interactive message inside body	"interactive": { "type": "location_request_message", "body": { "text": "Let us start with your pickup. You can either manually enter an address or share your current location." }, "action": { "name": "send_location" } }	Object	Required	Key should be interactive to send text message.

Sample Request

curl --location 'https://partner.gupshup.io/partner/app/{{APP_ID}}/v3/message' \
--header 'Authorization: {{PARTNER_APP_TOKEN}}' \
--header 'Content-Type: application/json' \
--data '{
  "messaging_product": "whatsapp",
  "recipient_type": "individual",
  "type": "interactive",
  "to": "+9188889xxx",
  "interactive": {
    "type": "location_request_message",
    "body": {
      "text": "Let us start with your pickup. You can either manually *enter an address* or *share your current location*."
    },
    "action": {
      "name": "send_location"
    }
  }
}'

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	Comment
Success
200	`{ "messages": [ { "id": "GUPSHUP_MESSAGE_ID" } ], "messaging_product": "whatsapp", "contacts": [ { "input": "DESTINATION_PHONE_NO", "wa_id": "DESTINATION_PHONE_NO" } ] }`
Error
401	`{ "status": "error", "message": "Authentication Failed" }`	When Partner Token authentication fails
400	`{ "message": "Callback Billing must be enabled for this API", "status": "error" }`

200Successful response

400Bad Request

401Unauthorized