Cadastrar email na conta
Método#
/security/email#
POST https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/security/email
Header#
| Key | Value |
|---|---|
| Client-Token | TOKEN DE SEGURANÇA DA CONTA |
Conceituação#
Método utilizado para cadastrar um email na sua conta do WhatsApp. Esse email pode ser utilizado mais tarde para recuperação do código PIN de segurança da sua conta.
Atenção
Essa API está disponível apenas para instâncias mobile.
Atributos#
Obrigatórios#
| Atributos | Tipo | Descrição |
|---|---|---|
| string | Email a ser cadastrado na sua conta do WhatsApp |
Request Body#
Response#
200#
| Atributos | Tipo | Descrição |
|---|---|---|
| success | boolean | Define se a requisição foi executada com sucesso |
| message | string | Em caso de sucesso, pode solicitar verificação do email (VERIFY_EMAIL). Sendo assim, um email será enviado para o endereço informado na requisição, contendo um código que deve ser usado na API de verificar email para concluir o cadastro. Em caso de falha, retorna uma mensagem a respeito do erro |
Exemplo#
400#
Requisição inválida. Verifique se os dados que você está enviando estão de acordo com o documentado acima.
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"