Atualizar descrição do canal

Altera a descrição de um canal existente

Header

Obrigatórios

Atributos

Request Body:

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

Response

201

Exemplo:

{
  "value": true
}

IMPORTANTE: 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”.

Alguns exemplos para auxiliar a implementação:

Exemplo em PHP:

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.plugzapi.com.br/instances/SUA_INSTANCIA/token/SEU_TOKEN/update-newsletter-description",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'id' => '<string>',
    'description' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Client-Token: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Exemplo em Python:

import requests

url = "https://api.plugzapi.com.br/instances/SUA_INSTANCIA/token/SEU_TOKEN/update-newsletter-description"

payload = {
    "id": "<string>",
    "description": "<string>"
}
headers = {
    "Client-Token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Exemplo em JavaScript:

const options = {
  method: 'POST',
  headers: {'Client-Token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({id: '<string>', description: '<string>'})
};

fetch('https://api.plugzapi.com.br/instances/SUA_INSTANCIA/token/SUA_TOKEN/update-newsletter-description', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));