Skip to main content
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
send-contacts
Send multiple contacts
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/send-contacts \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "<string>",
  "contacts": [
    {
      "name": "<string>",
      "phones": [
        {}
      ],
      "businessDescription": "<string>"
    }
  ]
}
'

​
Overview

Simple and straightforward, this method allows you to send multiple contacts. You don’t need to have them in your contacts, just fill in the method attributes with the contact information and send.

​
Attributes

​
instanceId
string
required
Your instance ID. Available in the Z-API panel under Instances.
​
token
string
required
Your Z-API instance token.

​
Required

​
phone
string
required
Recipient’s phone number (or group ID for group messages) in DDI DDD NUMBER format. E.g.: 551199999999
​
contacts
array
required
Array of contacts to be sent

​
Optional

​
messageId
string
Attribute used to reply to a chat message
​
delayMessage
number
Delay added to the message. You can choose between a range of 1 to 15 sec. The default delay if not provided is 1 to 3 sec

​
Request Body

{
  "phone": "5511999999999",
  "contacts": [
    {
      "name": "Contact name",
      "phones": ["5544999999999", "5544888888888"]
    },
    {
      "name": "Contact name",
      "phones": ["5544999999999"]
    },
    {
      "name": "Contact name",
      "businessDescription": "A company from Grupo Irrah",
      "phones": ["5544999999999"]
    }
  ]
}

​
Response

​
200

{
  "zaapId": "3999984263738042930CD6ECDE9VDWSA",
  "messageId": "D241XXXX732339502B68",
  "id": "D241XXXX732339502B68"
}

​
405

Make sure you are correctly sending the method specification, that is, verify that you sent POST or GET as specified at the beginning of this topic.

​
415

If you receive a 415 error, make sure to add the “Content-Type” header to your request, which in most cases is “application/json”.