Skip to main content
POST
/
send-catalog
Send catalog
curl --request POST \
  --url https://zapi.hubmessage.io/channels/{channel_id}/token/{channel_token}/send-catalog \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "phone": "5511999999999",
  "catalogPhone": "5511999999999",
  "translation": "EN",
  "message": "Follow this link to view our catalog on WhatsApp:",
  "title": "View the product catalog on WhatsApp",
  "catalogDescription": "Learn more about this company's products and services."
}
EOF
{
  "zaapId": "3999984263738042930CD6ECDE9VDWSA",
  "messageId": "D241XXXX732339502B68",
  "id": "D241XXXX732339502B68"
}

​
Overview

Method for sending the WhatsApp Business product catalog. The recipient receives a card with a link to view the full catalog.
This feature requires a WhatsApp Business account with a configured catalog and products.
The response structure is identical to Z-API. Your existing code that processes these returns will continue working without changes.

Authorizations

​
Authorization
string
header
required

Secret Key generated in the Hub Message Security panel

Body

application/json
​
phone
string
required

Recipient phone number (country code + area code + number)

Example:

"5511999999999"

​
catalogPhone
string
required

Phone number of the business account that owns the catalog

​
translation
enum<string>

Catalog card language

Available options:
EN,
PT
​
message
string

Message accompanying the catalog card

​
title
string

Catalog card title

​
catalogDescription
string

Catalog card description

Response

Message sent successfully

​
zaapId
string

Internal identifier

​
messageId
string

WhatsApp message ID

​
id
string

Same value as messageId (compatibility)