Este método é responsável por remover um usuário da administração do canal.
TIPO |
URL |
POST |
https://api.plugzapi.com.br/instances/SUA_INSTANCIA/token/SEU_TOKEN/newsletter/remove-admin/ID_CANAL |
Header
| Key | Value |
| Client-Token | TOKEN DE SEGURANÇA DA CONTA |
Content-type |
application/json |
Obrigatórios
Atributos |
Tipo |
Descrição |
|
instanceId (SUA_INSTANCIA) |
string obrigatório |
ID da sua instância. |
|
token (SEU_TOKEN) |
string obrigatórios |
Token da sua instância. |
Path
Atributos |
Tipo |
Descrição |
newsletterId (ID_CANAL) |
string obrigatório |
ID do canal. |
Atributos
Atributos |
Tipo |
Descrição |
phone |
string obrigatório |
Número do usuário a ser removido. |
Request Body
Exemplo:
{
"phone": "5511999999999"
}
Response
201
Retorno de sucesso.
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/newsletter/remove-admin/ID_CANAL",
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([
'phone' => '<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/newsletter/remove-admin/ID_CANAL"
payload = { "phone": "<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({phone: '<string>'})
};
fetch('https://api.plugzapi.com.br/instances/SUA_INSTANCIA/token/SEU_TOKEN/newsletter/remove-admin/ID_CANAL', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
Comentários
0 comentário
Por favor, entre para comentar.