Ads · Ad Campaigns

Create a standalone campaign

Creates a standalone campaign.

POSThttps://api.pozy.ai/v1/ads/campaigns
Facebook and Instagram, Google Workspace, LinkedIn, TikTok, X and Pinterest and 2 morecreateAdCampaign

Guides: 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

NameTypeNotes
Idempotency-KeystringUp to 255 charactersRetries with the same key return the original result. See Idempotency

Request body

application/json, required

  • accountIdstringrequired
  • adAccountIdstringrequired
  • namestringrequired

    Up to 255 characters.

  • goalstringrequired

    One of engagement, traffic, awareness, video_views, lead_generation, lead_conversion, job_applicants, conversions, app_promotion, catalog_sales, page_likes, page_visits.

  • isSkadnetworkAttributionboolean
  • promotedObjectobject
    11 child fields
    • pixelIdstring
    • customEventTypestring
    • customEventStrstring
    • pageIdstring
    • applicationIdstring
    • objectStoreUrlstring (URL)
    • customConversionIdstring
    • productCatalogIdstring
    • productSetIdstring
    • offlineConversionDataSetIdstring
    • whatsappPhoneNumberstring
  • buyingTypestring

    One of AUCTION, RESERVED.

  • validateOnlyboolean
  • specialAdCategoriesarray of string

    Each item: one of HOUSING, EMPLOYMENT, CREDIT, ISSUES_ELECTIONS_POLITICS, FINANCIAL_PRODUCTS_SERVICES, ONLINE_GAMBLING_AND_GAMING.

  • budgetAmountnumber
  • budgetTypestring

    One of daily, lifetime.

  • statusstring

    One of ACTIVE, PAUSED. Default PAUSED.

  • startDatestring (date-time)
  • endDatestring (date-time)
  • locationTargetingTypeobject
  • bidStrategystring

    One of LOWEST_COST_WITHOUT_CAP, LOWEST_COST_WITH_BID_CAP, COST_CAP, LOWEST_COST_WITH_MIN_ROAS.

  • bidAmountnumber
  • roasAverageFloornumber
  • portfolioBidStrategyIdstring

    Matches ^\d+$.

  • targetImpressionShareobject
    • locationstringrequired

      One of ANYWHERE_ON_PAGE, TOP_OF_PAGE, ABSOLUTE_TOP_OF_PAGE.

    • percentnumberrequired

      At most 100.

    • maxCpcnumberrequired
  • manualCpcobject
    • maxCpcnumberrequired
  • networkSettingsobject
    • searchPartnersboolean
    • displayNetworkboolean

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"
}'

Response

200 on success

  • validateOnlyboolean
  • adAccountIdstring
  • campaignIdstring

    Always ``.

  • objectivestring
  • statusstring

    Always VALIDATED.

200 response
{
  "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:

400invalid_request_errorA parameter or body field is missing or invalid. param names it.
401authentication_errorThe API key is missing, revoked or expired.
403permission_errorThe key is read-only, scoped to other profiles, or has this resource group disabled.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in Ad Campaigns

GETList adsGETList Google Ads recommendationsPOSTApply Google Ads recommendationsPOSTDismiss Google Ads recommendationsGETList portfolio bid strategiesPOSTCreate portfolio bid strategyPATCHUpdate portfolio bid strategyGETList shared budgetsPOSTCreate a shared budgetGETList Search keywordsPOSTAdd Search ad-group keywordsPATCHPause or enable a Search keywordDELRemove a Search keywordGETList campaignsPUTPause or resume a campaignGETRead a campaign's ad schedule (dayparting)PUTReplace a campaign's ad schedule (dayparting)GETRead a campaign's current biddingGETGet live campaign detailsPUTUpdate a campaignDELDelete a campaignGETList campaign-level negative keywordsPUTReplace campaign-level negative keywordsPOSTPause or resume many campaignsPOSTDuplicate a campaignGETRead a Google campaign's device, location, excluded location, and language targetingPUTEdit a Google campaign's device, location, excluded location, or language targetingGETList ad setsPOSTCreate a standalone ad groupPOSTDuplicate an ad setPOSTDuplicate an adGETGet live ad-set detailsPUTUpdate an ad setDELDelete an ad setGETRead a Reddit ad group's targeting and schedulePUTPause or resume a single ad setGETGet campaign treeGETGet daily account metricsGETGet ad detailsPUTUpdate adDELCancel an adPUTPause or resume a single adGETList campaign assetsPOSTAttach campaign assetsPUTUpdate campaign assetsDELRemove campaign assetsGETList ad-group assetsPOSTAttach ad-group assetsPUTUpdate ad-group assetsDELRemove ad-group assetsGETRead the platform's review verdict for an adGETReview status of each creative in a TikTok Smart+ adGETList ads that need attentionPOSTDismiss an ads alertGETReview status of every TikTok Smart+ ad of an advertiserGETList campaign negative listsPUTReplace campaign negative listsPOSTBoost post as adGETList Performance Max asset groupsPOSTCreate a Performance Max asset groupGETGet a Performance Max asset groupPATCHUpdate a Performance Max asset groupDELRemove a Performance Max asset groupPOSTLink or unlink asset group assetsPUTReplace an asset group's listing-group treePOSTCreate standalone adGETGet campaign conversion goalsPATCHUpdate campaign conversion goals