Pular para o conteúdo principal
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
catalogs
/
collection
Criar coleção
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/catalogs/collection \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "productIds": [
    {}
  ]
}
'
{
  "collectionId": "<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

Este método é responsável por criar uma nova coleção no catálogo do WhatsApp Business, permitindo agrupar produtos de forma organizada.

​
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

​
name
string
obrigatório
Nome da coleção
​
productIds
array
obrigatório
IDs dos produtos

​
Request Body

{
  "name": "Nome da coleção",
  "productIds": ["121212121212", "232323232323"]
}

​
Response

​
200

​
collectionId
string
ID da coleção criada
{
  "collectionId": "123456789123"
}

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