Pular para o conteúdo principal
GET
/
instances
/
{instanceId}
/
token
/
{token}
/
security
/
email
Buscar e-mail da conta
curl --request GET \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/security/email \
  --header 'Client-Token: <api-key>'
{
  "success": true,
  "hasEmail": true,
  "email": "<string>",
  "verified": true
}

Documentation Index

Fetch the complete documentation index at: https://developer.z-api.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Conceituação

Método utilizado para buscar o e-mail configurado na conta WhatsApp de uma instância mobile.
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.

​
Response

​
200

​
success
boolean
Retorna true caso a execução tenha sido bem-sucedida
​
hasEmail
boolean
Indica se a conta possui e-mail configurado
​
email
string
Endereço de e-mail configurado
​
verified
boolean
Status de verificação do e-mail
{
  "success": true,
  "hasEmail": true,
  "email": "example@email.com",
  "verified": true
}

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