Ads · Lead Gen
Updates a lead's status. Fields you leave out keep their current values. Works with Meta Ads.
Request
Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the contacts resource group disabled get 403 resource_group_disabled. Authentication
Path parameters
| Name | Type | Notes |
|---|---|---|
idrequired | string |
Request body
application/json, required
statusstringrequiredOne of
new,contacted,unreachable,qualified,converted,disqualified.valuenumberAt least 0.
currencystringaccountIdstring
Example
curl -X PATCH "https://api.pozy.ai/v1/ads/leads/6bfebd43ddc270f6d2c56fc5" \
-H "Authorization: Bearer $POZY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"status": "new"
}'const res = await fetch("https://api.pozy.ai/v1/ads/leads/6bfebd43ddc270f6d2c56fc5", {
method: "PATCH",
headers: {
Authorization: `Bearer ${process.env.POZY_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
status: "new"
}),
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);import os
import requests
resp = requests.patch(
"https://api.pozy.ai/v1/ads/leads/6bfebd43ddc270f6d2c56fc5",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
json={
"status": "new",
},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
statusstringleadobject21 child fields
idstringleadgenIdstringformIdstringformNamestringCan be null.
accountIdstringadIdstringCan be null.
adsetIdstringCan be null.
campaignIdstringCan be null.
isOrganicbooleancreatedTimestringCan be null.
fieldsmap of stringfieldDataarray of objectconsentsarray of object2 child fields
checkboxKeystringrequiredisCheckedbooleanrequired
statusstringOne of
new,contacted,unreachable,qualified,converted,disqualified.statusChangedAtstring (date-time)Can be null.
valuenumberCan be null.
currencystringCan be null.
contactIdstringCan be null.
firstContactedAtstring (date-time)Can be null.
conversationIdstringCan be null.
webhookDeliveredAtstring (date-time)Can be null.
{
"status": "active",
"lead": {
"id": "6bfebd43ddc270f6d2c56fc5",
"leadgenId": "6dca97cccbf47a98016ac05b",
"formId": "6da2ff1d8c680bca61eb524a",
"formName": "Acme",
"accountId": "696e0b682d0a31188e7a2ba9",
"adId": "6f40fa2fb0a7e728dd1a73b7",
"adsetId": "6766358a9af7b9dbb7d42ea6",
"campaignId": "65a3737dd8b11ea61f199e6e",
"isOrganic": true,
"createdTime": "string",
"fields": {
"key": "string"
},
"fieldData": [
{}
],
"consents": [
{
"checkboxKey": "string",
"isChecked": true
}
],
"status": "new",
"statusChangedAt": "2026-10-02T09:00:00.000Z",
"value": 12.5,
"currency": "USD",
"contactId": "642d31f43531ce7d44aa5013",
"firstContactedAt": "2026-10-02T09:00:00.000Z",
"conversationId": "6e525f3820fc636aa96d2ee9",
"webhookDeliveredAt": "2026-10-02T09:00:00.000Z"
}
}Errors
Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:
| 400 | invalid_request_error | A parameter or body field is missing or invalid. param names it. |
| 401 | authentication_error | The API key is missing, revoked or expired. |
| 403 | permission_error | The key is read-only, scoped to other profiles, or has this resource group disabled. |
| 404 | not_found | Nothing with that id exists in your workspace. |
| 429 | rate_limit_error | Too many requests this minute. Wait for Retry-After seconds. |
Every code is listed in Errors.