--- updatedAt: 2026-06-26T06:38:13.000Z agentTools: projectIndex: https://partner-docs.gupshup.io/llms.txt --- # Contact Message Use this API to send Contact messages Contacts messages allow you to send rich contact information directly to Whats App users, such as names, phone numbers, physical addresses, and email addresses. #### [Meta Contact Message Doc Link](https://developers.facebook.com/docs/whatsapp/cloud-api/messages/contacts-messages)
> 📘 Note: > > 1. Use the `recipient` parameter only when BSUID is enabled for the app. > 2. When both `to` and `recipient` fields are used in the payload, the `to` field gets the priority. ## Request Parameters | Key | Description | Value | Data type | Required/Optional | Constraints | | :----------------- | :---------------------------------------------------------- | :----------------------------- | :-------- | :------------------------------------------------------------------------------------------------- | :------------------------------------------------ | | Authorization | Access Token for the application | \{\{PARTNER\_APP\_TOKEN}} | String | Required | Should be a valid Partner App Access Token | | appId | App ID to fetch the access token | \{\{APP\_ID}} | String | Required | The ID should be a valid Gupshup app ID. | | messaging\_product | Messaging product | whatsapp | String | Required | | | recipient\_type | Recipient type | individual | String | Required | | | to | Destination phone number where the message needs to be sent | 91785876xxxx | 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 | Destination BSUID where the message needs to be sent | IN.461449821882xxxx | String | Optional | Must be a valid BSUID | | type | Messaging type | contacts | String | Required | Type should be contacts to send contacts message. | | contacts | Add contact body | "contacts":\[\] | Array | Required | Key should be contacts to send contact message. | ## Sample Request ```curl 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}}", "recipient": "{{BSUID}}", "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**
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
# OpenAPI definition ```json { "openapi": "3.0.0", "info": { "title": "Contacts", "version": "1.0.0" }, "servers": [ { "url": "https://partner.gupshup.io" } ], "paths": { "/partner/app/{appId}/v3/message": { "post": { "tags": [ "default" ], "summary": "Contact Message", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "messaging_product": "whatsapp", "to": "9173861902xx", "type": "contacts", "contacts": [ { "addresses": [ { "street": "1 Lucky Shrub Way", "city": "Menlo Park", "state": "CA", "zip": "94025", "country": "United States", "country_code": "US", "type": "Office" }, { "street": "1 Hacker Way", "city": "Menlo Park", "state": "CA", "zip": "94025", "country": "United States", "country_code": "US", "type": "Pop-Up" } ], "birthday": "1999-01-23", "emails": [ { "email": "bjohnson@luckyshrub.com", "type": "Work" }, { "email": "bjohnson@luckyshrubplants.com", "type": "Work (old)" } ], "name": { "formatted_name": "Barbara J. Johnson", "first_name": "Barbara", "last_name": "Johnson", "middle_name": "Joana", "suffix": "Esq.", "prefix": "Dr." }, "org": { "company": "Lucky Shrub", "department": "Legal", "title": "Lead Counsel" }, "phones": [ { "phone": "+16505559999", "type": "Landline" }, { "phone": "+19175559999", "type": "Mobile", "wa_id": "19175559999" } ], "urls": [ { "url": "https://www.luckyshrub.com", "type": "Company" }, { "url": "https://www.facebook.com/luckyshrubplants", "type": "Company (FB)" } ] } ] } } } } }, "parameters": [ { "name": "token", "in": "header", "schema": { "type": "string" }, "description": "Your app token, please refer [**Get access token api**](https://partner-docs.gupshup.io/reference/get_partner-app-appid-token#/) to get the token from partner documentation.", "example": "sk_61b3021c97214370b341f8baaae0xxxx", "required": true }, { "name": "appId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "Unique identifier of the app.", "example": "9e97650d-xxxx-xxxx-xxxx-4cdf47c3fa68" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "messages": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "GUPSHUP_MESSAGE_ID" } } }, "example": [ { "id": "GUPSHUP_MESSAGE_ID" } ] }, "messaging_product": { "type": "string", "example": "whatsapp" }, "contacts": { "type": "array", "items": { "type": "object", "properties": { "input": { "type": "string", "example": "DESTINATION_PHONE_NO" }, "wa_id": { "type": "string", "example": "DESTINATION_PHONE_NO" } } }, "example": [ { "input": "DESTINATION_PHONE_NO", "wa_id": "DESTINATION_PHONE_NO" } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Callback Billing must be enabled for this API" }, "status": { "type": "string", "example": "error" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Authentication Failed" }, "status": { "type": "string", "example": "error" } } } } } } }, "description": "Use this API to send Contact messages" } } } } ```