Pular para o conteúdo principal
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
security
/
email
Cadastrar e-mail na conta
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/security/email \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>"
}
'
{
  "success": true,
  "message": "<string>"
}

​
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.
Essa API está disponível apenas para instâncias mobile.

​
Atributos

​
instanceId
string
obrigatório
ID da sua instância. Disponível no painel Z-API em Instâncias.
​
token
string
obrigatório
Token da sua instância Z-API.

​
Body

​
email
string
obrigatório
Email a ser cadastrado

​
Request Body

{
  "email": "example@email.com"
}

​
Response

​
200

​
success
boolean
Retorna true caso a solicitação tenha sido realizada com sucesso
​
message
string
Retorna VERIFY_EMAIL indicando que um e-mail de verificação foi enviado para o endereço fornecido, contendo um código necessário para completar o registro através da API de verificação.
{
  "success": true,
  "message": "VERIFY_EMAIL"
}

​
400

Requisição inválida. Verifique se os dados que você está enviando estão de acordo com o documentado.

​
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”.