Ads · Ad Campaigns
Creates a standalone campaign.
https://api.pozy.ai/v1/ads/campaignsGuides: Meta Ads, Reddit Ads, ChatGPT Ads
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
Headers
| Name | Type | Notes |
|---|---|---|
Idempotency-Key | string | Up to 255 charactersRetries with the same key return the original result. See Idempotency |
Request body
application/json, required
accountIdstringrequiredadAccountIdstringrequirednamestringrequiredUp to 255 characters.
goalstringrequiredOne of
engagement,traffic,awareness,video_views,lead_generation,lead_conversion,job_applicants,conversions,app_promotion,catalog_sales,page_likes,page_visits.isSkadnetworkAttributionbooleanpromotedObjectobject11 child fields
pixelIdstringcustomEventTypestringcustomEventStrstringpageIdstringapplicationIdstringobjectStoreUrlstring (URL)customConversionIdstringproductCatalogIdstringproductSetIdstringofflineConversionDataSetIdstringwhatsappPhoneNumberstring
buyingTypestringOne of
AUCTION,RESERVED.validateOnlybooleanspecialAdCategoriesarray of stringEach item: one of
HOUSING,EMPLOYMENT,CREDIT,ISSUES_ELECTIONS_POLITICS,FINANCIAL_PRODUCTS_SERVICES,ONLINE_GAMBLING_AND_GAMING.budgetAmountnumberbudgetTypestringOne of
daily,lifetime.statusstringOne of
ACTIVE,PAUSED. DefaultPAUSED.startDatestring (date-time)endDatestring (date-time)locationTargetingTypeobjectbidStrategystringOne of
LOWEST_COST_WITHOUT_CAP,LOWEST_COST_WITH_BID_CAP,COST_CAP,LOWEST_COST_WITH_MIN_ROAS.bidAmountnumberroasAverageFloornumberportfolioBidStrategyIdstringMatches
^\d+$.targetImpressionShareobjectlocationstringrequiredOne of
ANYWHERE_ON_PAGE,TOP_OF_PAGE,ABSOLUTE_TOP_OF_PAGE.percentnumberrequiredAt most 100.
maxCpcnumberrequired
manualCpcobjectmaxCpcnumberrequired
networkSettingsobjectsearchPartnersbooleandisplayNetworkboolean
Example
curl -X POST "https://api.pozy.ai/v1/ads/campaigns" \
-H "Authorization: Bearer $POZY_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{
"accountId": "696e0b682d0a31188e7a2ba9",
"adAccountId": "666219aad7bab67ace411e4f",
"name": "Acme",
"goal": "engagement"
}'import { randomUUID } from "node:crypto";
const res = await fetch("https://api.pozy.ai/v1/ads/campaigns", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.POZY_API_KEY}`,
"Idempotency-Key": randomUUID(),
"Content-Type": "application/json",
},
body: JSON.stringify({
accountId: "696e0b682d0a31188e7a2ba9",
adAccountId: "666219aad7bab67ace411e4f",
name: "Acme",
goal: "engagement"
}),
});
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/campaigns",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
json={
"accountId": "696e0b682d0a31188e7a2ba9",
"adAccountId": "666219aad7bab67ace411e4f",
"name": "Acme",
"goal": "engagement",
},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
validateOnlybooleanadAccountIdstringcampaignIdstringAlways ``.
objectivestringstatusstringAlways
VALIDATED.
{
"validateOnly": true,
"adAccountId": "666219aad7bab67ace411e4f",
"campaignId": "",
"objective": "string",
"status": "VALIDATED"
}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. |
| 429 | rate_limit_error | Too many requests this minute. Wait for Retry-After seconds. |
Every code is listed in Errors.