Pular para o conteúdo principal
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
update-newsletter-description
Atualizar descrição do canal
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/update-newsletter-description \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "description": "<string>"
}
'
{
  "value": true
}

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 alterar a descrição de um canal já existente.

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

​
Body

​
id
string
obrigatório
ID do canal com sufixo @newsletter
​
description
string
obrigatório
Nova descrição do canal

​
Request Body

{
  "id": "999999999999999999@newsletter",
  "description": "Nova descrição do canal"
}

​
Response

​
201

​
value
boolean
true caso tenha dado certo e false em caso de falha
{
  "value": true
}
O ID do canal sempre deve conter o sufixo @newsletter, pois esse é o padrão utilizado pelo próprio WhatsApp.

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