Skip to main content
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
catalogs
/
collection-edit
/
{collectionId}
Edit collection
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/catalogs/collection-edit/{collectionId} \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'
{
  "success": true,
  "collectionId": "<string>"
}

​
Overview

This method is responsible for editing an existing collection in the WhatsApp Business catalog.

​
Attributes

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

​
Path

​
collectionId
string
required
ID of the collection to be edited

​
Required

​
name
string
required
New collection name

​
Request Body

{
  "name": "Novo nome da coleção"
}

​
Response

​
200

​
success
boolean
true if successful, false if it failed
​
collectionId
string
ID of the edited collection
{
  "success": true,
  "collectionId": "228078660281007"
}

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