Ads · Lead Gen
Archives a lead form. Works with Meta Ads and LinkedIn Ads.
DELETE
https://api.pozy.ai/v1/ads/lead-forms/{formId}Facebook and Instagram and LinkedInarchiveLeadForm
Guide: Lead forms
Request
Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the ads resource group disabled get 403 resource_group_disabled. Authentication
Path parameters
| Name | Type | Notes |
|---|---|---|
formIdrequired | string |
Query parameters
| Name | Type | Notes |
|---|---|---|
accountIdrequired | string |
Example
curl -X DELETE "https://api.pozy.ai/v1/ads/lead-forms/6da2ff1d8c680bca61eb524a?accountId=696e0b682d0a31188e7a2ba9" \
-H "Authorization: Bearer $POZY_API_KEY"const res = await fetch("https://api.pozy.ai/v1/ads/lead-forms/6da2ff1d8c680bca61eb524a?accountId=696e0b682d0a31188e7a2ba9", {
method: "DELETE",
headers: { Authorization: `Bearer ${process.env.POZY_API_KEY}` },
});
const text = await res.text();
const data = text ? JSON.parse(text) : null;
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);import os
import requests
resp = requests.delete(
"https://api.pozy.ai/v1/ads/lead-forms/6da2ff1d8c680bca61eb524a",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
params={
"accountId": "696e0b682d0a31188e7a2ba9",
},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
statusstringformIdstringarchivedboolean
200 response
{
"status": "active",
"formId": "6da2ff1d8c680bca61eb524a",
"archived": true
}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.