Sending Messages with Contact Details via WhatsApp

Last updated: 22 January 2026

To send contact details to the WhatsApp channel, use the method api/v1/out-messages/whatsapp.

tip

The method api/v1/out-messages/whatsapp refer to the new API version.

Calling the Method

To send a message with contact details to the WhatsApp channel, send a POST request to the URL https://app.edna.io/api/v1/out-messages/whatsapp.

Request Format

{
    "sender": "string",
    "phone": "string",
    "content": {
        "type": "string",
        "name": {
            "name": "string",
            "firstName": "string",
            "lastName": "string"
        },
        "phones": [
            {
                "phone": "string",
                "type": "string",
                "userId": "string"
            },
            {
                "phone": "string",
                "type": "string",
            },
            {
                "phone": "string",
                "type": "string",
            },
        ],
        "addresses": [
            {
                "city": "string",
                "country": "string",
                "street": "string",
                "type": "string"
            },
            {
                "city": "string",
                "country": "string",
                "street": "string",
                "type": "string"
            }
        ],
        "emails": [
            {
                "email": "string",
                "type": "string"
            },
            {
                "email": "string",
                "type": "string"
            }
        ],
        "urls": [
            {
                "url": "string",
                "type": "string"
            },
            {
                "url": "string",
                "type": "string"
            }
        ],
        "org": {
            "company": "string",
            "department": "string",
            "title": "string"
        }
    }
} 

Request Example

{

    "sender": "wa_subject_1",
    "phone": "+19165550100",
    "content": {
        "type": "CONTACT",
        "name": {
            "name": "John Director",
            "firstName": "John",
            "lastName": "Public"
        },
        "phones": [
            {
                "phone": "+19165550101",
                "type": "CELL",
                "userId": "19165550101"
            },
            {
                "phone": "+19165550199",
                "type": "WORK",
            },
            {
                "phone": "+19165550111",
                "type": "HOME",
            },
        ],
        "addresses": [
            {
                "city": "Sacramento",
                "country": "USA",
                "street": "2210 Sloat Way",
                "type": "HOME"
            },
            {
                "city": "Sacramento",
                "country": "USA",
                "street": "2733 Riverside Blvd",
                "type": "WORK"
            }
        ],
        "emails": [
            {
                "email": "[email protected]",
                "type": "HOME"
            },
            {
                "email": "[email protected]",
                "type": "WORK"
            }
        ],
        "urls": [
            {
                "url": "nicesite.com",
                "type": "HOME"
            },
            {
                "url": "lovelywork.com",
                "type": "WORK"
            }
        ],
        "org": {
            "company": "Publishing house KnightHood",
            "department": "Legal Department",
            "title": "Director of the Legal Department"
        }
    }
} 

Request Parameters

Parameter	Data type	Character	Description
`sender`	string	Required	Signature title. To find out the name of the signature, use the API method to get a list of channels — the `subject` parameter. Receiving List of Channels
`phone`	string	Required	The recipient's address — a phone number. To find out the recipient's address, use the API method to request recipient data — the `addresses.address` parameter. Requesting Client Data
`content`	object	Required	An object containing information about the message content.
`content.type`	string	Required	Message content type. Possible values: - `TEXT` — text message; - `IMAGE` — image; - `DOCUMENT` — document attached to the message; - `VIDEO` — message containing a video; - `AUDIO` — message containing sound; - `LOCATION` — message with coordinates, address, and description of the location. Coordinates are converted into a Google Maps satellite image - `LIST_PICKER` — WhatsApp interactive menu buttons; - `FLOW` — message containing WhatsApp Flows. - `CONTACT` — message containing contact details.
`content.name`	object	Required	An object containing information about contact names.
`content.name.name`	string	Required	Contact name. Maximum length: 1024 characters.
`content.name.firstName`	string	Optional	Contact first name. Maximum length: 1024 characters.
`content.name.lastName`	string	Optional	Contact last name. Maximum length: 1024 characters.
`content.phones`	array of objects	Optional	Array of phone numbers.
`content.phones.phone`	string	Optional	Phone number. Maximum length: 1024 characters.
`content.phones.type`	string	Optional	Telephone number type. Possible values: - `HOME` – home; - `WORK` – work; - `IPHONE` – iPhone; - `MAIN` – main; - `CELL` – mobile.
`content.phones.userId`	string	Optional	If the value is specified, the WhatsApp ID (the phone number associated with the account) will be transferred to the WhatsApp application. In this case, the contact will be displayed with the “Write” and ‘Save’ buttons. If the value is not specified, the contact will be displayed with the “Add” button. The maximum length is 1024 characters.
`content.addresses`	array of objects	Optional	Array of residential and location addresses.
`content.addresses.city`	string	Optional	City of contact. Maximum length — 1024 characters.
`content.addresses.country`	string	Optional	Country of contact. Maximum length: 1024 characters.
`content.addresses.street`	string	Optional	Contact street. Maximum length — 1024 characters.
`content.addresses.type`	string	Optional	Type of contact address. Possible values: - `HOME` – home; - `WORK` – work.
`content.emails`	array of objects	Optional	Array of email addresses.
`content.emails.email`	string	Optional	Contact email address. Maximum length: 1024 characters.
`content.emails.type`	string	Optional	Type of contact email address. Possible values: - `HOME` – home; - `WORK` – work.
`content.urls`	array of objects	Optional	Array of web page addresses.
`content.urls.url`	string	Optional	Web page address. Maximum length: 1024 characters.
`content.urls.type`	string	Optional	Type of web page address. Possible values: - `HOME` – home; - `WORK` – work.
`content.org`	object	Optional	Object with information about the company.
`content.org.company`	string	Optional	Name of the company. Maximum length — 1024 characters.
`content.org.department`	string	Optional	Company department. Maximum length: 1024 characters.
`content.org.title`	string	Optional	Contact position. Maximum length — 1024 characters.

Response Format

{
    "outMessageId": "string",
    "phone": "string"
}  

Response Example

{
    "outMessageId": "020be4b9-bb7d-781d-8517-913fa44e80e6",
    "phone": "+19165550100"
} 

Response Parameters

Parameter	Data type	Description
`outMessageId`	string	Internal identifier of the outgoing message.
`phone`	string	Recipient's address — phone number.

Calling the Method​

Request Format​

Request Example​

Request Parameters​

Response Format​

Response Example​

Response Parameters​