Pular para o conteúdo principal
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
catalogs
/
collection-edit
/
{collectionId}
Editar coleção
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>"
}

​
Conceituação

Este método é responsável por editar uma coleção existente no catálogo do WhatsApp Business.

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

​
Path

​
collectionId
string
obrigatório
ID da coleção a ser editada

​
Obrigatórios

​
name
string
obrigatório
Novo nome da coleção

​
Request Body

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

​
Response

​
200

​
success
boolean
true caso tenha dado certo e false em caso de falha
​
collectionId
string
ID da coleção editada
{
  "success": true,
  "collectionId": "228078660281007"
}

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