Send catalog
curl --request POST \
--url https://api.omni.z-api.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."
}
EOFimport requests
url = "https://api.omni.z-api.io/channels/{channel_id}/token/{channel_token}/send-catalog"
payload = {
"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."
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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.'
})
};
fetch('https://api.omni.z-api.io/channels/{channel_id}/token/{channel_token}/send-catalog', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.omni.z-api.io/channels/{channel_id}/token/{channel_token}/send-catalog",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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.'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.omni.z-api.io/channels/{channel_id}/token/{channel_token}/send-catalog"
payload := strings.NewReader("{\n \"phone\": \"5511999999999\",\n \"catalogPhone\": \"5511999999999\",\n \"translation\": \"EN\",\n \"message\": \"Follow this link to view our catalog on WhatsApp:\",\n \"title\": \"View the product catalog on WhatsApp\",\n \"catalogDescription\": \"Learn more about this company's products and services.\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.omni.z-api.io/channels/{channel_id}/token/{channel_token}/send-catalog")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"phone\": \"5511999999999\",\n \"catalogPhone\": \"5511999999999\",\n \"translation\": \"EN\",\n \"message\": \"Follow this link to view our catalog on WhatsApp:\",\n \"title\": \"View the product catalog on WhatsApp\",\n \"catalogDescription\": \"Learn more about this company's products and services.\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.omni.z-api.io/channels/{channel_id}/token/{channel_token}/send-catalog")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"phone\": \"5511999999999\",\n \"catalogPhone\": \"5511999999999\",\n \"translation\": \"EN\",\n \"message\": \"Follow this link to view our catalog on WhatsApp:\",\n \"title\": \"View the product catalog on WhatsApp\",\n \"catalogDescription\": \"Learn more about this company's products and services.\"\n}"
response = http.request(request)
puts response.read_body{
"zaapId": "3999984263738042930CD6ECDE9VDWSA",
"messageId": "D241XXXX732339502B68",
"id": "D241XXXX732339502B68"
}{
"error": 405,
"message": "Method not allowed"
}{
"error": 415,
"message": "Unsupported media type"
}Messages
Send catalog
Send the WhatsApp Business product catalog
POST
/
send-catalog
Send catalog
curl --request POST \
--url https://api.omni.z-api.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."
}
EOFimport requests
url = "https://api.omni.z-api.io/channels/{channel_id}/token/{channel_token}/send-catalog"
payload = {
"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."
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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.'
})
};
fetch('https://api.omni.z-api.io/channels/{channel_id}/token/{channel_token}/send-catalog', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.omni.z-api.io/channels/{channel_id}/token/{channel_token}/send-catalog",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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.'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.omni.z-api.io/channels/{channel_id}/token/{channel_token}/send-catalog"
payload := strings.NewReader("{\n \"phone\": \"5511999999999\",\n \"catalogPhone\": \"5511999999999\",\n \"translation\": \"EN\",\n \"message\": \"Follow this link to view our catalog on WhatsApp:\",\n \"title\": \"View the product catalog on WhatsApp\",\n \"catalogDescription\": \"Learn more about this company's products and services.\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.omni.z-api.io/channels/{channel_id}/token/{channel_token}/send-catalog")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"phone\": \"5511999999999\",\n \"catalogPhone\": \"5511999999999\",\n \"translation\": \"EN\",\n \"message\": \"Follow this link to view our catalog on WhatsApp:\",\n \"title\": \"View the product catalog on WhatsApp\",\n \"catalogDescription\": \"Learn more about this company's products and services.\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.omni.z-api.io/channels/{channel_id}/token/{channel_token}/send-catalog")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"phone\": \"5511999999999\",\n \"catalogPhone\": \"5511999999999\",\n \"translation\": \"EN\",\n \"message\": \"Follow this link to view our catalog on WhatsApp:\",\n \"title\": \"View the product catalog on WhatsApp\",\n \"catalogDescription\": \"Learn more about this company's products and services.\"\n}"
response = http.request(request)
puts response.read_body{
"zaapId": "3999984263738042930CD6ECDE9VDWSA",
"messageId": "D241XXXX732339502B68",
"id": "D241XXXX732339502B68"
}{
"error": 405,
"message": "Method not allowed"
}{
"error": 415,
"message": "Unsupported media type"
}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.
Authorizations
Secret Key generated in the Omni Z-API Security panel
Body
application/json
Recipient phone number (country code + area code + number)
Example:
"5511999999999"
Phone number of the business account that owns the catalog
Catalog card language
Available options:
EN, PT Message accompanying the catalog card
Catalog card title
Catalog card description