Pular para o conteúdo principal

Atualizar configurações do canal

Método#

/newsletter/settings/{newsletterId}#

POST https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/newsletter/settings/{newsletterId}

Header#

KeyValue
Client-TokenTOKEN DE SEGURANÇA DA CONTA

Conceituação#

Este método é responsável por alterar as configurações de um canal.


Atributos#

Obrigatórios#

AtributosTipoDescrição
idstringID do canal. Enviado no PATH da requisição (EX: newsletter/settings/999999999999999999@newsletter)
reactionCodesstringDefine a restrição de reações nas mensagens (basic, all)

(string) reactionCodes

ValoresTipoDescrição
basicstringPermite apenas o envio de reações básicas
allstringPermite o envio de qualquer reação

Request Body#

URL#

Método

POST https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/newsletter/settings/999999999999999999@newsletter

Body#

{
"reactionCodes": "basic | all"
}
warning

O id do canal sempre deve conter o sufixo "@newsletter", pois esse é o padrão utilizado pelo próprio Whatsapp.


Response#

201#

AtributosTipoDescrição
valuebooleantrue caso tenha dado certo e false em caso de falha

Exemplo

{
"value": true
}

405#

Neste caso certifique que esteja enviando o corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no inicio 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"


Webhook Response#

Link para a response do webhook (ao receber)

Webhook


Code#