Skip to main content
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
catalogs
/
collection
Create collection
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>"
}

​
Overview

This method is responsible for creating a new collection in the WhatsApp Business catalog, allowing you to organize products into groups.

​
Attributes

​
instanceId
string
required
Your instance ID. Available in the Z-API panel under Instances.
​
token
string
required
Your Z-API instance token.

​
Required

​
name
string
required
Collection name
​
productIds
array
required
Product IDs

​
Request Body

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

​
Response

​
200

​
collectionId
string
ID of the created collection
{
  "collectionId": "123456789123"
}

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