Skip to main content
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
security
/
email
Register account email
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>"
}

​
Overview

Method used to register an email on your WhatsApp account. This email can be used later to recover your account’s security PIN code.
This API is only available for mobile instances.

​
Attributes

​
instanceId
string
required
Your instance ID. Available in the Z-API panel under Instances.
​
token
string
required
Your Z-API instance token.

​
Body

​
email
string
required
Email to be registered

​
Request Body

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

​
Response

​
200

​
success
boolean
Returns true if the request was successful
​
message
string
Returns VERIFY_EMAIL indicating that a verification email was sent to the provided address, containing a code needed to complete the registration through the verification API.
{
  "success": true,
  "message": "VERIFY_EMAIL"
}

​
400

Invalid request. Check if the data you are sending matches the documentation.

​
405

Make sure you are correctly sending the method specification, that is, verify that you sent POST or GET as specified at the beginning of this topic.

​
415

If you receive a 415 error, make sure to add the “Content-Type” header to your request, which in most cases is “application/json”.