Ads · Ad Campaigns
Boosts a post as ad.
https://api.pozy.ai/v1/ads/boostGuides: Boost posts, Ads, Meta 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
creativeFeaturesmap of stringpostIdstringplatformPostIdstringaccountIdstringrequiredadAccountIdstringrequirednamestringrequiredUp to 255 characters.
campaignNamestringUp to 255 characters.
adSetNamestringUp to 255 characters.
goalstringrequiredOne of
engagement,traffic,awareness,video_views,lead_generation,conversions,app_promotion.adSetIdstringexistingCampaignIdstringidentityIdstringidentityTypestringOne of
TT_USER,CUSTOMIZED_USER,BC_AUTH_TT.budgetAmountnumberbudgetTypestringOne of
daily,lifetime.lifetimeBudgetCapnumberbudgetobjectdeprecatedamountnumberrequiredtypestringrequiredOne of
daily,lifetime.
instagramAccountIdstringdestinationTypestringOne of
INSTAGRAM_PROFILE,WEBSITE,ON_AD,MESSENGER,WHATSAPP,INSTAGRAM_DIRECT.whatsappPhoneNumberstringMatches
^\+[1-9]\d{6,14}$.workflowIdstringMatches
^[a-fA-F0-9]{24}$.currencystring3 to 3 characters.
startDatestring (date-time)endDatestring (date-time)scheduleobjectdeprecatedstartDatestring (date-time)deprecatedendDatestring (date-time)deprecated
targetingobject12 child fields
ageMininteger13 to 65.
ageMaxinteger13 to 65.
genderstringOne of
all,male,female.languagesarray of stringcountriesarray of stringregionsarray of object2 child fields
keystringrequirednamestring
citiesarray of object4 child fields
keystringrequirednamestringradiusnumberdistanceUnitstringOne of
mile,kilometer.
zipsarray of object2 child fields
keystringrequirednamestring
metrosarray of object2 child fields
keystringrequirednamestring
customLocationsarray of object6 child fields
latitudenumberrequired-90 to 90.
longitudenumberrequired-180 to 180.
radiusnumberrequireddistanceUnitstringrequiredOne of
mile,kilometer.namestringaddressstring
interestsarray of object2 child fields
idstringrequirednamestringrequired
advantage_audienceintegerOne of
0,1.
locationTargetingTypeobjectrawTargetingobjectbidStrategyobjectdeprecatedbidAmountnumberdeprecatedroasAverageFloornumberdeprecatedplatformSpecificDataobjectOne of:
Linked In Ads settings (16 fields)
costTypestringOne of
CPM,CPC,CPV.unitCostnumberoptimizationTargetTypestringcreativeSelectionstringOne of
OPTIMIZED,ROUND_ROBIN.audienceExpansionEnabledbooleanoffsiteDeliveryEnabledbooleanconnectedTelevisionOnlybooleancarouselobject1 child field
cardsarray of objectrequiredAt least 2 items. Up to 10 items.
3 child fields
imageUrlstring (URL)requiredheadlinestringlandingUrlstring (URL)
documentobject2 child fields
urlstring (URL)requiredtitlestringrequired
spotlightobject8 child fields
headlinestringrequireddescriptionstringcallToActionstringrequiredlandingUrlstring (URL)requiredlogoUrlstring (URL)organizationNamestringshowMemberProfilePhotobooleanbackgroundImageUrlstring (URL)
followerobject6 child fields
headlineobjectrequired2 child fields
preApprovedstringcustomstring
descriptionobjectrequired2 child fields
preApprovedstringcustomstring
callToActionstringrequiredOne of
VISIT_ORGANIZATION_COMPANY_PAGE,VISIT_ORGANIZATION_LIFE_PAGE,VISIT_ORGANIZATION_JOBS_PAGE,VISIT_ORGANIZATION_CAREERS_PAGE.logoUrlstring (URL)organizationNamestringshowMemberProfilePhotoboolean
jobsobject5 child fields
headlineobjectrequired2 child fields
preApprovedstringcustomstring
buttonLabelobjectrequired2 child fields
preApprovedstringcustomstring
logoUrlstring (URL)organizationNamestringshowMemberProfilePhotoboolean
textAdobject4 child fields
headlinestringrequiredUp to 25 characters.
descriptionstringrequiredUp to 75 characters.
landingUrlstring (URL)requiredimageUrlstring (URL)
conversationobject7 child fields
subjectstringrequiredsenderstringbodystringfooterstringheadlinestringfirstMessageIdstringrequiredmessagesarray of objectrequiredAt least 1 item. Up to 25 items.
3 child fields
idstringrequiredtextstringrequiredUp to 500 characters.
buttonsarray of objectAt least 1 item. Up to 5 items.
3 child fields
textstringrequiredUp to 35 characters.
nextMessageIdstringurlstring (URL)
eventobject1 child field
urnstringrequiredMatches
^urn:li:event:\d+$.
thoughtLeaderobject1 child field
postUrnstringrequiredMatches
^urn:li:(share|ugcPost):\d+$.
Meta Ads settings (7 fields)
bidStrategystringOne of
LOWEST_COST_WITHOUT_CAP,LOWEST_COST_WITH_BID_CAP,COST_CAP,LOWEST_COST_WITH_MIN_ROAS.bidAmountnumberroasAverageFloornumberdailyMinSpendTargetnumberlifetimeMinSpendTargetnumbercustomerLifecycleobject3 child fields
strategystringrequiredOne of
all_customers,new_customers,new_customers_excluding_engaged.existingCustomerAudienceIdsarray of stringengagedAudienceIdsarray of string
adScheduleobjectAt least 1 item.
4 child fields
dayOfWeekstringrequiredOne of
MONDAY,TUESDAY,WEDNESDAY,THURSDAY,FRIDAY,SATURDAY,SUNDAY.startHourintegerrequired0 to 23.
endHourintegerrequired1 to 24.
timezoneTypestringOne of
USER,ADVERTISER. DefaultUSER.
trackingobjectpixelIdstringurlTagsarray of object2 child fields
keystringvaluestring
specialAdCategoriesarray of stringEach item: one of
HOUSING,EMPLOYMENT,CREDIT,FINANCIAL_PRODUCTS_SERVICES,ISSUES_ELECTIONS_POLITICS,ONLINE_GAMBLING_AND_GAMING.specialAdCategoryCountryarray of stringregionalRegulatedCategoriesarray of stringregionalRegulationIdentitiesmap of string or integerlinkUrlstring (URL)callToActionstringsparkAuthCodestringsmartPlusbooleansparkPostsarray of objectAt least 1 item. Up to 50 items.
platformPostIdstringrequiredsparkAuthCodestringrequired
promoCodesarray of objectAt least 1 item. Up to 10 items.
7 child fields
discountTypestringrequiredOne of
PERCENTAGE,CASH.discountValuenumberrequireddiscountCurrencystringpromoCodestringUp to 30 characters.
minimumPurchaseTypestringOne of
QUANTITY,SUBTOTAL.minimumPurchaseValuenumberminimumPurchaseCurrencystring
promotedObjectobjectpixelIdstringcustomEventTypestringcustomEventStrstringcustomConversionIdstring
dsaBeneficiarystringUp to 100 characters.
dsaPayorstringUp to 100 characters.
leadGenFormIdstringstatusstringOne of
ACTIVE,PAUSED.campaignStatusstringOne of
ACTIVE,PAUSED.adSetStatusstringOne of
ACTIVE,PAUSED.adStatusstringOne of
ACTIVE,PAUSED.budgetLevelstringOne of
adset,campaign.attributionSpecarray of objectAt least 1 item. Up to 3 items.
eventTypestringrequiredOne of
CLICK_THROUGH,VIEW_THROUGH,ENGAGED_VIDEO_VIEW.windowDaysintegerrequiredOne of
1,7,28.
bodiesarray of stringAt least 1 item. Up to 5 items.
rehostOnInstagramVideoRejectionbooleanDefault
true.smartTargetingobjectaudiencebooleaninterestsBehaviorsboolean
optimizationGoalstringmetaObjectivestringOne of
OUTCOME_ENGAGEMENT.validateOnlybooleanDefault
false.
Example
curl -X POST "https://api.pozy.ai/v1/ads/boost" \
-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/boost", {
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/boost",
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
validateOnlybooleanresultsarray of objectnodestringOne of
campaign,adSet,creative,ad.statusstringOne of
validated,skipped,unverified.reasonstring
messagestring
{
"validateOnly": true,
"results": [
{
"node": "campaign",
"status": "validated",
"reason": "string"
}
],
"message": "Hello from Pozy"
}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.