Send catalog
Method#
/send-catalog#
POST https://api.z-api.io/instances/YOUR_INSTANCE/token/YOUR_TOKEN/send-catalog
Header#
| Key | Value |
|---|---|
| Client-Token | ACCOUNT SECURITY TOKEN |
Concept#
In this method, you can send messages with a link to your catalog. The catalog feature is only available for business WhatsApp accounts. It is also necessary for the account to have products and a configured catalog. Operations related to products and collections can be found in the WhatsApp Business section of our documentation.
Attributes#
Required#
| Attribute | Type | Description |
|---|---|---|
| phone | string | Recipient's phone number (or group ID for group messages) in the format DDI DDD NUMBER E.g., 551199999999. IMPORTANT Send only numbers, without formatting or mask |
| catalogPhone | string | Phone number of the business account to which the catalog belongs. |
Optional#
| Attribute | Type | Description |
|---|---|---|
| translation | string | Language of the default message of the catalog card (EN/PT). |
| message | string | Message sent with the catalog card. |
| title | string | Title of the catalog card. |
| catalogDescription | string | Description sent with the card catalog. |
Request Body#
Response#
200#
| Attribute | Type | Description |
|---|---|---|
| zaapId | string | id in z-api |
| messageId | string | id in WhatsApp |
| id | string | Added for compatibility with Zapier, it has the same value as messageId |
Example
405#
In this case, make sure you are correctly sending the method specification, i.e., check if you sent the 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" of the object you are sending to the headers of the request, mostly "application/json"
Webhook Response#
Link to the webhook response (upon receipt)