Pular para o conteúdo principal
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
send-catalog
Enviar catálogo
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>"
}
'

Documentation Index

Fetch the complete documentation index at: https://developer.z-api.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Conceituação

Neste método você poderá enviar mensagens com o link para o seu catálogo. O recurso de catálogo está disponível apenas para contas business do WhatsApp que possuam produtos cadastrados.

​
Exemplo no WhatsApp

​
Atributos

​
instanceId
string
obrigatório
ID da sua instância. Disponível no painel Z-API em Instâncias.
​
token
string
obrigatório
Token da sua instância Z-API.

​
Obrigatórios

​
phone
string
obrigatório
Telefone (ou ID do grupo para casos de envio para grupos) do destinatário no formato DDI DDD NÚMERO. Ex: 551199999999
​
catalogPhone
string
obrigatório
Telefone da conta business a qual pertence o catálogo

​
Opcionais

​
translation
string
Idioma da mensagem (EN ou PT)
​
message
string
Mensagem enviada junto com o card do catálogo
​
title
string
Título do card do catálogo
​
catalogDescription
string
Descrição no card do catálogo

​
Request Body

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

​
Response

​
200

{
  "zaapId": "3999984263738042930CD6ECDE9VDWSA",
  "messageId": "D241XXXX732339502B68",
  "id": "D241XXXX732339502B68"
}

​
405

Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no início deste tópico.

​
415

Caso você receba um erro 415, certifique de adicionar na headers da requisição o “Content-Type” do objeto que você está enviando, em sua grande maioria “application/json”.