Ads · Lead Gen
Creates a test lead. Works with Meta Ads.
POST
https://api.pozy.ai/v1/ads/lead-forms/{formId}/test-leadsFacebook and InstagramcreateTestLead
Guide: Lead forms
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 |
|---|---|---|
formIdrequired | string |
Request body
application/json, required
accountIdstringrequiredfieldDataarray of objectrequiredAt least 1 item.
namestringrequiredvaluesarray of stringrequiredAt least 1 item.
Example
curl -X POST "https://api.pozy.ai/v1/ads/lead-forms/6da2ff1d8c680bca61eb524a/test-leads" \
-H "Authorization: Bearer $POZY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"accountId": "696e0b682d0a31188e7a2ba9",
"fieldData": [
{
"name": "Acme",
"values": [
"string"
]
}
]
}'const res = await fetch("https://api.pozy.ai/v1/ads/lead-forms/6da2ff1d8c680bca61eb524a/test-leads", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.POZY_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
accountId: "696e0b682d0a31188e7a2ba9",
fieldData: [
{
name: "Acme",
values: [
"string"
]
}
]
}),
});
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.post(
"https://api.pozy.ai/v1/ads/lead-forms/6da2ff1d8c680bca61eb524a/test-leads",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
json={
"accountId": "696e0b682d0a31188e7a2ba9",
"fieldData": [
{
"name": "Acme",
"values": [
"string",
],
},
],
},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
statusstringtestLeadobjectidstring
200 response
{
"status": "active",
"testLead": {
"id": "6bfebd43ddc270f6d2c56fc5"
}
}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.