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

​
Overview

With this method you can send messages of your products. The products feature is only available for WhatsApp business accounts.
The account must have registered products. Product operations are documented in the WhatsApp Business section.

​
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 product
​
productId
string
required
Product ID. Can be obtained from the list products API

​
Request Body

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

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

​
Webhook Response

Link to the webhook response (on receive) Webhook