Pular para o conteúdo principal

Transferir propriedade do canal

Método#

/newsletter/transfer-ownership/{newsletterId}#

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

Header#

KeyValue
Client-TokenTOKEN DE SEGURANÇA DA CONTA

Conceituação#

Este método é responsável por transferir a propriedade de um canal a outro usuário, o qual seja administrador desse canal.

Atributos#

Obrigatórios#

AtributosTipoDescrição
phonestringTelefone do usuário que será promovido a dono do canal

Opcionais#

AtributosTipoDescrição
quitAdminbooleanDefine se você deixará de ser administrador do canal após transferir a propriedade

Request Body#

{
"phone": "5511999999999"
}
{
"phone": "5511999999999",
"quitAdmin": true
}

Response#

200#

AtributosTipoDescrição
valuestringRetorna true em caso de sucesso e false em caso de falha
messagestringEm caso de erro, pode retornar uma mensagem com informações sobre o erro

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#