CRM and Leads
Edit Lead
Edits the lead data of a contact. The ID must include @s.whatsapp.net.
POST
https://api.zapzapapi.com/api/v1/{instanceId}/chat/editLeadAuthentication with the x-api-key and x-api-secret headers.
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
id | text | body | Yes | Chat ID (format: number@s.whatsapp.net) |
lead_name | text | body | No | Lead name |
lead_email | text | body | No | Lead email |
lead_status | text | body | No | Lead status in the funnel |
lead_isTicketOpen | select | body | No | Ticket open |
lead_tags | textarea | body | No | Tags (JSON array) |
lead_notes | textarea | body | No | Notes about the lead |
lead_field01 | text | body | No | Custom field 01 |
lead_field02 | text | body | No | Custom field 02 |
chatbot_disableUntil | number | body | No | Disable chatbot until (UTC timestamp, 0 to re-enable) |
lead_personalid | text | body | No | Lead Personalid |
lead_field03 | text | body | No | Lead Field03 |
lead_field04 | text | body | No | Lead Field04 |
lead_field05 | text | body | No | Lead Field05 |
Request example
curl
curl -X POST "https://api.zapzapapi.com/api/v1/{instanceId}/chat/editLead" \
-H "x-api-key: YOUR_API_KEY" \
-H "x-api-secret: YOUR_API_SECRET" \
-H "Content-Type: application/json" \
-d '{"id":"5511999999999@s.whatsapp.net"}'Node.js
const res = await fetch("https://api.zapzapapi.com/api/v1/{instanceId}/chat/editLead", {
method: "POST",
headers: {
"x-api-key": "YOUR_API_KEY",
"x-api-secret": "YOUR_API_SECRET",
"Content-Type": "application/json",
},
body: JSON.stringify({
"id": "5511999999999@s.whatsapp.net"
}),
});
console.log(await res.json());Python
import requests
res = requests.post(
"https://api.zapzapapi.com/api/v1/{instanceId}/chat/editLead",
headers={"x-api-key": "YOUR_API_KEY", "x-api-secret": "YOUR_API_SECRET"},
json={"id":"5511999999999@s.whatsapp.net"},
)
print(res.json())Response example
JSON
{
"chat": {
"lead_name": "Joao",
"lead_email": "joao@email.com"
},
"source": "local"
}Values are illustrative; the fields follow the real response format.
Other endpoints in this category
Get your API keys
Create your account, connect a number in minutes and start using the API. R$15 per active number/month, with a welcome credit when you create the account, subject to the current campaign.