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

​
Overview

With this method you can send messages with a link to your catalog. The catalog feature is only available for WhatsApp business accounts that have registered products.

​
Example on WhatsApp

​
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
​
catalogPhone
string
required
Phone number of the business account that owns the catalog

​
Optional

​
translation
string
Message language (EN or PT)
​
message
string
Message sent along with the catalog card
​
title
string
Catalog card title
​
catalogDescription
string
Description in the catalog card

​
Request Body

{
  "phone": "5511999999999",
  "catalogPhone": "5511999999999"
}

​
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”.