Contact Message

Contacts messages allow you to send rich contact information directly to WhatsApp users, such as names, phone numbers, physical addresses, and email addresses.

Request Parameters

Key	Description	Values	Data Types	Required/Optional	Constraints
Authorization	Access Token for the application	`{{PARTNER_APP_TOKEN}}`	String	Required	Should be a valid Partner App Access Token.
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
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 address message.
contacts	Add contact body	`"contacts":[<contacts body>]`	Array	Required	Key should be `contacts` to send contact message.

Sample Request

curl --location --request POST 'https://partner.gupshup.io/partner/app/{{{APP_ID}}/v3/message' \
--header 'Authorization: {{PARTNER_APP_TOKEN}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "messaging_product": "whatsapp",
    "to": "{{WHATSAPP_USER_PHONE_NUMBER}}",
    "type": "contacts",
    "contacts": [
        {
            "addresses": [
                {
                    "street": "{{STREET_NUMBER_AND_NAME}}",
                    "city": "{{CITY}}",
                    "state": "{{STATE_CODE}}",
                    "zip": "{{ZIP_CODE}}",
                    "country": "{{COUNTRY_NAME}}",
                    "country_code": "{{COUNTRY_CODE}}",
                    "type": "{{ADDRESS_TYPE}}"
                }
                /* Additional addresses objects go here, if using */
            ],
            "birthday": "{{BIRTHDAY}}",
            "emails": [
                {
                    "email": "{{EMAIL_ADDRESS}}",
                    "type": "{{EMAIL_TYPE}}"
                }
                /* Additional emails objects go here, if using*/
            ],
            "name": {
                "formatted_name": "{{FULL_NAME}}",
                "first_name": "{{FIRST_NAME}}",
                "last_name": "{{LAST_NAME}}",
                "middle_name": "{{MIDDLE_NAME}}",
                "suffix": "{{SUFFIX}}",
                "prefix": "{{PREFIX}}"
            },
            "org": {
                "company": "{{COMPANY_OR_ORG_NAME}}",
                "department": "{{DEPARTMENT_NAME}}",
                "title": "{{JOB_TITLE}}"
            },
            "phones": [
                {
                    "phone": "{{PHONE_NUMBER}}",
                    "type": "{{PHONE_NUMBER_TYPE}}",
                    "wa_id": "{{WHATSAPP_USER_ID}}"
                }
                /* Additional phones objects go here, if using */
            ],
            "urls": [
                {
                    "url": "{{WEBSITE_URL}}",
                    "type": "{{WEBSITE_TYPE}}"
                }
                /* Additional URLs go here, if using */
            ]
        }
    ]
}'

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
401	`{ "status": "error", "message": "Authentication Failed" }`	When API key authentication fails
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