Contact messages

A contact message shares one or more contact cards. The user can save each contact to their address book or start a chat with it directly.

To receive contact cards from users, see WhatsApp inbound.

Contacts array

Add a contacts item to richContent.conversation. Each element of the array is one contact card.

Field	Type	Required	Description
name	object	Yes	Name of the contact. See Name.
phones	array	No	Phone numbers of the contact.
emails	array	No	Email addresses of the contact.
addresses	array	No	Postal addresses of the contact.
org	object	No	Organisation details of the contact.
urls	array	No	Websites of the contact.
birthday	string	No	Birthday in YYYY-MM-DD format.

Name

Required name fields

formatted_name is required, and at least one of first_name, last_name, middle_name, prefix or suffix.

Field	Description
formatted_name	Full name as displayed in WhatsApp.
first_name	First name.
last_name	Last name.
middle_name	Middle name.
prefix	Name prefix, for example Dr.
suffix	Name suffix, for example Jr.

Other objects

Object	Fields
phones[]	phone, type (for example WORK, HOME, MOBILE)
emails[]	email, type (for example WORK, HOME)
addresses[]	street, city, zip, country, country_code, type
org	company, department, title
urls[]	url, type (for example WORK, HOME)

Example

Contact message

{
  "messages": {
    "authentication": {
      "productToken": "YOUR_PRODUCT_TOKEN"
    },
    "msg": [
      {
        "from": "00316098765432",
        "to": [
          { "number": "00316012345678" }
        ],
        "body": {
          "type": "auto",
          "content": "Fallback text"
        },
        "allowedChannels": ["WhatsApp"],
        "richContent": {
          "conversation": [
            {
              "contacts": [
                {
                  "name": {
                    "formatted_name": "CM.com HQ",
                    "first_name": "CM.com",
                    "last_name": "HQ"
                  },
                  "phones": [
                    { "phone": "+31 76 123 4567", "type": "WORK" }
                  ],
                  "emails": [
                    { "email": "[email protected]", "type": "WORK" }
                  ],
                  "addresses": [
                    {
                      "street": "Konijnenberg 30",
                      "city": "Breda",
                      "zip": "4825 BD",
                      "country": "Netherlands",
                      "country_code": "NL",
                      "type": "WORK"
                    }
                  ],
                  "org": {
                    "company": "CM.com",
                    "department": "Development",
                    "title": "Developer"
                  },
                  "urls": [
                    { "url": "https://www.cm.com", "type": "WORK" }
                  ],
                  "birthday": "2000-01-01"
                }
              ]
            }
          ]
        }
      }
    ]
  }
}