pozyDocs
Dashboard

Ads · Ad Campaigns

Create standalone ad

Creates a standalone ad.

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

Guides: Ads, Meta Ads, TikTok 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
  • namestring

    Up to 255 characters.

  • campaignNamestring

    Up to 255 characters.

  • adSetNamestring

    Up to 255 characters.

  • adNamestring

    Up to 255 characters.

  • trackingobject
    • pixelIdstring
    • urlTagsarray of object
      2 child fields
      • keystringrequired
      • valuestringrequired
    • pozyTagboolean

      Default false.

  • goalstring

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

  • smartTargetingobject
    • audienceboolean
    • interestsBehaviorsboolean
  • optimizationGoalstring
  • billingEventstring
  • buyingTypestring

    One of AUCTION, RESERVED. Default AUCTION.

  • rfPredictionIdstring
  • promotionobject

    Can be null.

  • creativeFeaturesmap of string
  • catalogFormatstring

    One of single_image, carousel_images_multi_items, carousel_images_single_item, carousel_slideshows.

  • multiAdvertiserstring

    One of OPT_IN, OPT_OUT.

  • aiDisclosurestring

    One of OPT_IN, OPT_OUT.

  • validateOnlyboolean
  • budgetAmountnumber
  • budgetTypestring

    One of daily, lifetime.

  • statusstring

    One of ACTIVE, PAUSED.

  • campaignStatusstring

    One of ACTIVE, PAUSED.

  • adSetStatusstring

    One of ACTIVE, PAUSED.

  • adStatusstring

    One of ACTIVE, PAUSED.

  • budgetLevelstring

    One of adset, campaign. Default adset.

  • currencystring

    3 to 3 characters.

  • headlinestring
  • longHeadlinestring

    Up to 90 characters.

  • bodystring
  • descriptionstring

    Up to 255 characters.

  • bodiesarray of string

    At least 1 item. Up to 5 items.

  • headlinesarray of string

    At least 1 item. Up to 5 items. Each item: up to 255 characters.

  • descriptionsarray of string

    At least 1 item. Up to 5 items. Each item: up to 255 characters.

  • callToActionstring

    One of BOOK_TRAVEL, CONTACT_US, DONATE, DONATE_NOW, DOWNLOAD, GET_DIRECTIONS, GO_LIVE, INTERESTED, LEARN_MORE, SEE_DETAILS, LIKE_PAGE, MESSAGE_PAGE, RAISE_MONEY, SAVE, SEND_TIP, SHOP_NOW, SIGN_UP, VIEW_INSTAGRAM_PROFILE, INSTAGRAM_MESSAGE, LOYALTY_LEARN_MORE, PURCHASE_GIFT_CARDS, PAY_TO_ACCESS, SEE_MORE, TRY_IN_CAMERA and 100 more.

  • linkUrlstring (URL)
  • leadGenFormIdstring
  • imageUrlstring (URL)
  • imagesobject
    • landscapestring (URL)
    • squarestring (URL)
  • videoobject
    • urlstring (URL)
    • idstring
    • thumbnailUrlstring (URL)
  • creativesarray of object

    At least 1 item.

    9 child fields
    • creativeFeaturesmap of string
    • namestring

      Up to 255 characters.

    • headlinestringrequired

      Up to 255 characters.

    • bodystringrequired
    • descriptionstring

      Up to 255 characters.

    • imageUrlstring (URL)
    • videoobject
      2 child fields
      • urlstring (URL)required
      • thumbnailUrlstring (URL)
    • linkUrlstring (URL)required
    • callToActionstringrequired

      One of BOOK_TRAVEL, CONTACT_US, DONATE, DONATE_NOW, DOWNLOAD, GET_DIRECTIONS, GO_LIVE, INTERESTED, LEARN_MORE, SEE_DETAILS, LIKE_PAGE, MESSAGE_PAGE, RAISE_MONEY, SAVE, SEND_TIP, SHOP_NOW, SIGN_UP, VIEW_INSTAGRAM_PROFILE, INSTAGRAM_MESSAGE, LOYALTY_LEARN_MORE, PURCHASE_GIFT_CARDS, PAY_TO_ACCESS, SEE_MORE, TRY_IN_CAMERA and 94 more.

  • adSetIdstring
  • existingCampaignIdstring
  • phoneNumberstring

    Matches ^\+[1-9]\d{6,14}$.

  • existingCreativeIdstring
  • businessNamestring

    Up to 25 characters.

  • boardIdstring
  • organizationIdstring
  • targetingobject
    31 child fields
    • userOsarray of string

      At least 1 item.

    • userDevicearray of string

      At least 1 item.

    • countriesarray of string
    • regionsarray of string or object

      One of:

      string
      Option 2 (2 fields)
      • keystringrequired
      • namestring
    • citiesarray of string or object

      One of:

      string
      Option 2 (4 fields)
      • keystringrequired
      • namestring
      • radiusnumber
      • distanceUnitstring

        One of mile, kilometer.

    • zipsarray of object
      2 child fields
      • keystringrequired
      • namestring
    • metrosarray of object
      2 child fields
      • keystringrequired
      • namestring
    • countryGroupsarray of string

      Each item: one of africa, asia, europe, north_america, south_america, oceania, central_america, caribbean, eea, euro_area, nafta, mercosur, afta, apec, gcc, cisfta, emerging_markets, itunes_app_store, android_free_store, android_paid_store.

    • customLocationsarray of object
      6 child fields
      • latitudenumberrequired

        -90 to 90.

      • longitudenumberrequired

        -180 to 180.

      • radiusnumberrequired
      • distanceUnitstringrequired

        One of mile, kilometer.

      • namestring
      • addressstring
    • excludedLocationsobject
      8 child fields
      • countriesarray of string
      • countryGroupsarray of string

        Each item: one of africa, asia, europe, north_america, south_america, oceania, central_america, caribbean, eea, euro_area, nafta, mercosur, afta, apec, gcc, cisfta, emerging_markets, itunes_app_store, android_free_store, android_paid_store.

      • regionsarray of object
        2 child fields
        • keystringrequired
        • namestring
      • citiesarray of object
        3 child fields
        • keystringrequired
        • radiusnumber
        • distanceUnitstring

          One of mile, kilometer.

      • zipsarray of object
        2 child fields
        • keystringrequired
        • namestring
      • placesarray of object
        1 child field
        • keystringrequired
      • neighborhoodsarray of object
        1 child field
        • keystringrequired
      • customLocationsarray of object
        6 child fields
        • latitudenumberrequired

          -90 to 90.

        • longitudenumberrequired

          -180 to 180.

        • radiusnumberrequired
        • distanceUnitstringrequired

          One of mile, kilometer.

        • namestring
        • addressstring
    • ageMininteger

      13 to 100.

    • ageMaxinteger

      13 to 100.

    • genderstring

      One of all, male, female.

    • incomeTierstring

      One of top_5, top_10, top_10_25, top_25_50.

    • languagesarray of string
    • interestsarray of object
      2 child fields
      • idstringrequired
      • namestring
    • behaviorsarray of object
      2 child fields
      • idstringrequired
      • namestring
    • workPositionsarray of object
      2 child fields
      • idstringrequired
      • namestring
    • workEmployersarray of object
      2 child fields
      • idstringrequired
      • namestring
    • workIndustriesarray of object
      2 child fields
      • idstringrequired
      • namestring
    • industriesarray of string
    • companySizesarray of string
    • senioritiesarray of string
    • jobFunctionsarray of string
    • skillsarray of string
    • audienceIncludearray of string
    • audienceExcludearray of string
    • communitiesarray of string
    • excludedCommunitiesarray of string
    • conversationKeywordsarray of string
    • excludedConversationKeywordsarray of string
  • countriesarray of string
  • countryGroupsarray of string

    Each item: one of africa, asia, europe, north_america, south_america, oceania, central_america, caribbean, eea, euro_area, nafta, mercosur, afta, apec, gcc, cisfta, emerging_markets, itunes_app_store, android_free_store, android_paid_store.

  • citiesarray of string or object

    One of:

    string
    Option 2 (3 fields)
    • keystringrequired
    • radiusnumber
    • distance_unitstring

      One of mile, kilometer.

  • regionsarray of string or object

    One of:

    string
    Option 2 (1 fields)
    • keystringrequired
  • ageMininteger

    13 to 65.

  • ageMaxinteger

    13 to 65.

  • interestsarray of object
    • idstringrequired
    • namestringrequired
  • zipsarray of string or object

    One of:

    string
    Option 2 (2 fields)
    • keystringrequired
    • namestring
  • metrosarray of string or object

    One of:

    string
    Option 2 (2 fields)
    • keystringrequired
    • namestring
  • customLocationsarray of object
    • latitudenumberrequired

      -90 to 90.

    • longitudenumberrequired

      -180 to 180.

    • radiusnumberrequired
    • distanceUnitstringrequired

      One of mile, kilometer.

    • namestring
    • addressstring
  • behaviorsarray of object
    • idstringrequired
    • namestring
  • workPositionsarray of object
    • idstringrequired
    • namestring
  • workEmployersarray of object
    • idstringrequired
    • namestring
  • workIndustriesarray of object
    • idstringrequired
    • namestring
  • incomeTierstring

    One of top_5, top_10, top_10_25, top_25_50.

  • languagesarray of string
  • placementsobject
    8 child fields
    • publisherPlatformsarray of string

      Each item: one of facebook, instagram, threads, messenger, audience_network, whatsapp.

    • facebookPositionsarray of string

      Each item: one of feed, right_hand_column, marketplace, story, search, instream_video, facebook_reels, facebook_reels_overlay, profile_feed, notification.

    • instagramPositionsarray of string

      Each item: one of stream, story, explore, explore_home, reels, profile_feed, ig_search, profile_reels.

    • messengerPositionsarray of string

      Each item: one of messenger_home, sponsored_messages, story.

    • audienceNetworkPositionsarray of string

      Each item: one of classic, rewarded_video.

    • threadsPositionsarray of string

      Each item: one of threads_stream.

    • whatsappPositionsarray of string

      Each item: one of status.

    • devicePlatformsarray of string

      Each item: one of mobile, desktop.

  • savedTargetingIdstring
  • rawTargetingobject
  • specialAdCategoriesarray of string

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

  • specialAdCategoryCountryarray of string
  • regionalRegulatedCategoriesarray of string
  • regionalRegulationIdentitiesmap of string or integer
  • endDatestring (date-time)
  • startDatestring (date-time)
  • pageIdstring
  • instagramAccountIdstring
  • dynamicCreativeobject
    8 child fields
    • imageUrlsarray of string (URL)

      At least 1 item. Up to 10 items.

    • videoUrlsarray of string (URL)

      At least 1 item. Up to 10 items.

    • bodiesarray of string

      Up to 5 items.

    • titlesarray of string

      Up to 5 items.

    • descriptionsarray of string

      Up to 5 items.

    • linkUrlsarray of string (URL)
    • callToActionTypesarray of string

      Each item: one of BOOK_TRAVEL, CONTACT_US, DONATE, DONATE_NOW, DOWNLOAD, GET_DIRECTIONS, GO_LIVE, INTERESTED, LEARN_MORE, SEE_DETAILS, LIKE_PAGE, MESSAGE_PAGE, RAISE_MONEY, SAVE, SEND_TIP, SHOP_NOW, SIGN_UP, VIEW_INSTAGRAM_PROFILE, INSTAGRAM_MESSAGE, LOYALTY_LEARN_MORE, PURCHASE_GIFT_CARDS, PAY_TO_ACCESS, SEE_MORE, TRY_IN_CAMERA and 94 more.

    • adFormatstring

      One of SINGLE_IMAGE, CAROUSEL_IMAGE, SINGLE_VIDEO.

  • carouselCardsarray of object

    At least 2 items. Up to 10 items.

    • imageUrlstring (URL)required
    • linkUrlstring (URL)
    • headlinestring

      Up to 255 characters.

    • descriptionstring

      Up to 255 characters.

    • callToActionstring
  • optimizeCardOrderboolean
  • defaultLocalestring
  • translationsarray of object

    At least 1 item. Up to 10 items.

    8 child fields
    • localestringrequired
    • headlinestringrequired

      Up to 255 characters.

    • bodystringrequired
    • descriptionstringrequired

      Up to 255 characters.

    • linkUrlstring (URL)
    • imageUrlstring (URL)
    • videoUrlstring (URL)
    • thumbnailUrlstring (URL)
  • placementAssetsobject
    • defaultImageUrlstring (URL)
    • defaultVideoUrlstring (URL)
    • defaultThumbnailUrlstring (URL)
    • rulesarray of objectrequired

      At least 1 item. Up to 10 items.

      7 child fields
      • imageUrlstring (URL)
      • videoUrlstring (URL)
      • thumbnailUrlstring (URL)
      • headlinestring

        1 to 255 characters.

      • bodystring
      • descriptionstring

        1 to 255 characters.

      • placementsobjectrequired
        8 child fields
        • publisherPlatformsarray of string

          Each item: one of facebook, instagram, threads, messenger, audience_network, whatsapp.

        • facebookPositionsarray of string

          Each item: one of feed, right_hand_column, marketplace, story, search, instream_video, facebook_reels, facebook_reels_overlay, profile_feed, notification.

        • instagramPositionsarray of string

          Each item: one of stream, story, explore, explore_home, reels, profile_feed, ig_search, profile_reels.

        • messengerPositionsarray of string

          Each item: one of messenger_home, sponsored_messages, story.

        • audienceNetworkPositionsarray of string

          Each item: one of classic, rewarded_video.

        • threadsPositionsarray of string

          Each item: one of threads_stream.

        • whatsappPositionsarray of string

          Each item: one of status.

        • devicePlatformsarray of string

          Each item: one of mobile, desktop.

  • audienceIdstring
  • campaignTypestring

    One of display, search, pmax, demand_gen. Default display.

  • locationTargetingTypeobject
  • assetGroupobject
    8 child fields
    • namestring

      1 to 128 characters.

    • finalUrlstring (URL)required

      Matches ^https?://.

    • headlinesarray of stringrequired

      At least 3 items. Up to 15 items. Each item: 1 to 30 characters.

    • longHeadlinestringrequired

      1 to 90 characters.

    • descriptionsarray of stringrequired

      At least 2 items. Up to 5 items. Each item: 1 to 90 characters.

    • businessNamestringrequired

      1 to 25 characters.

    • imagesobjectrequired
      3 child fields
      • landscapearray of string (URL)required

        At least 1 item. Up to 20 items. Each item: matches ^https?://.

      • squarearray of string (URL)required

        At least 1 item. Up to 20 items. Each item: matches ^https?://.

      • logoarray of string (URL)required

        At least 1 item. Up to 5 items. Each item: matches ^https?://.

    • youtubeVideoIdstring

      Matches ^[A-Za-z0-9_-]{11}$.

  • demandGenobject
    13 child fields
    • adGroupNamestring

      Up to 255 characters.

    • finalUrlstring (URL)required
    • businessNamestringrequired

      Up to 25 characters.

    • headlinesarray of stringrequired

      At least 1 item. Up to 5 items. Each item: up to 40 characters.

    • longHeadlinesarray of string

      At least 1 item. Up to 5 items. Each item: up to 90 characters.

    • descriptionsarray of stringrequired

      At least 1 item. Up to 5 items. Each item: up to 90 characters.

    • callToActionstring

      Up to 25 characters.

    • imagesobjectrequired
      4 child fields
      • landscapearray of string (URL)

        At least 1 item. Up to 20 items.

      • squarearray of string (URL)

        At least 1 item. Up to 20 items.

      • portraitarray of string (URL)

        At least 1 item. Up to 20 items.

      • logoarray of string (URL)required

        At least 1 item. Up to 5 items.

    • youtubeVideoIdsarray of string

      At least 1 item. Up to 5 items. Each item: matches ^[A-Za-z0-9_-]{11}$.

    • carouselCardsarray of object

      At least 2 items. Up to 10 items.

      4 child fields
      • headlinestringrequired

        Up to 40 characters.

      • finalUrlstring (URL)
      • callToActionstring

        Up to 25 characters.

      • imagesobjectrequired
        3 child fields
        • landscapestring (URL)
        • squarestring (URL)
        • portraitstring (URL)
    • channelsarray of string

      At least 1 item. Each item: one of youtube_in_stream, youtube_in_feed, youtube_shorts, discover, gmail, display.

    • audienceobject
      5 child fields
      • userListsarray of string

        At least 1 item. Up to 20 items.

      • userInterestsarray of string

        At least 1 item. Up to 20 items.

      • customAudiencesarray of string

        At least 1 item. Up to 20 items.

      • ageRangesarray of object

        At least 1 item. Up to 6 items.

        2 child fields
        • minintegerrequired

          One of 18, 25, 35, 45, 55, 65.

        • maxinteger

          One of 24, 34, 44, 54, 64.

      • gendersarray of string

        At least 1 item. Up to 3 items. Each item: one of male, female, undetermined.

    • audienceIdstring
  • keywordsarray of string or object

    Up to 1000 items.

    One of:

    string
    Option 2 (2 fields)
    • textstringrequired

      1 to 80 characters.

    • matchTypestring

      One of exact, phrase, broad.

  • negativeKeywordsarray of string or object

    Up to 1000 items.

    One of:

    string
    Option 2 (2 fields)
    • textstringrequired

      1 to 80 characters.

    • matchTypestring

      One of exact, phrase, broad.

  • campaignNegativeKeywordsarray of string or object

    Up to 1000 items.

    One of:

    string
    Option 2 (2 fields)
    • textstringrequired

      1 to 80 characters.

    • matchTypestring

      One of exact, phrase, broad.

  • additionalHeadlinesarray of string or object

    One of:

    string
    Google Rsa Headline (2 fields)
    • textstringrequired

      1 to 30 characters.

    • pinnedFieldstring

      One of HEADLINE_1, HEADLINE_2, HEADLINE_3.

  • additionalDescriptionsarray of string or object

    One of:

    string
    Google Rsa Description (2 fields)
    • textstringrequired

      1 to 90 characters.

    • pinnedFieldstring

      One of DESCRIPTION_1, DESCRIPTION_2.

  • sitelinksarray of object

    At least 2 items. Up to 20 items.

    • textstringrequired

      1 to 25 characters.

    • linkUrlstring (URL)required
    • description1string

      1 to 35 characters.

    • description2string

      1 to 35 characters.

  • calloutsarray of string

    At least 1 item. Up to 20 items. Each item: 1 to 25 characters.

  • structuredSnippetsarray of object

    At least 1 item. Up to 20 items.

    • headerstringrequired

      One of Amenities, Brands, Courses, Degree programs, Destinations, Featured hotels, Insurance coverage, Models, Neighborhoods, Service catalog, Shows, Styles, Types.

    • valuesarray of stringrequired

      At least 3 items. Up to 10 items. Each item: 1 to 25 characters.

  • advantageAudienceinteger

    One of 0, 1.

  • attributionSpecarray of object

    At least 1 item. Up to 3 items.

    • eventTypestringrequired

      One of CLICK_THROUGH, VIEW_THROUGH, ENGAGED_VIDEO_VIEW.

    • windowDaysintegerrequired

      One of 1, 7, 28.

  • genderstring

    One of all, male, female. Default all.

  • bidStrategyobjectdeprecated
  • bidAmountnumberdeprecated
  • roasAverageFloornumberdeprecated
  • 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
  • valueRuleSetIdstring

    Matches ^\d+$.

  • valueRulesAppliedboolean
  • platformSpecificDataobject

    One of:

    Linked In Ads settings (16 fields)
    • costTypestring

      One of CPM, CPC, CPV.

    • unitCostnumber
    • optimizationTargetTypestring
    • creativeSelectionstring

      One of OPTIMIZED, ROUND_ROBIN.

    • audienceExpansionEnabledboolean
    • offsiteDeliveryEnabledboolean
    • connectedTelevisionOnlyboolean
    • carouselobject
      1 child field
      • cardsarray of objectrequired

        At least 2 items. Up to 10 items.

        3 child fields
        • imageUrlstring (URL)required
        • headlinestring
        • landingUrlstring (URL)
    • documentobject
      2 child fields
      • urlstring (URL)required
      • titlestringrequired
    • spotlightobject
      8 child fields
      • headlinestringrequired
      • descriptionstring
      • callToActionstringrequired
      • landingUrlstring (URL)required
      • logoUrlstring (URL)
      • organizationNamestring
      • showMemberProfilePhotoboolean
      • backgroundImageUrlstring (URL)
    • followerobject
      6 child fields
      • headlineobjectrequired
        2 child fields
        • preApprovedstring
        • customstring
      • descriptionobjectrequired
        2 child fields
        • preApprovedstring
        • customstring
      • callToActionstringrequired

        One of VISIT_ORGANIZATION_COMPANY_PAGE, VISIT_ORGANIZATION_LIFE_PAGE, VISIT_ORGANIZATION_JOBS_PAGE, VISIT_ORGANIZATION_CAREERS_PAGE.

      • logoUrlstring (URL)
      • organizationNamestring
      • showMemberProfilePhotoboolean
    • jobsobject
      5 child fields
      • headlineobjectrequired
        2 child fields
        • preApprovedstring
        • customstring
      • buttonLabelobjectrequired
        2 child fields
        • preApprovedstring
        • customstring
      • logoUrlstring (URL)
      • organizationNamestring
      • showMemberProfilePhotoboolean
    • textAdobject
      4 child fields
      • headlinestringrequired

        Up to 25 characters.

      • descriptionstringrequired

        Up to 75 characters.

      • landingUrlstring (URL)required
      • imageUrlstring (URL)
    • conversationobject
      7 child fields
      • subjectstringrequired
      • senderstring
      • bodystring
      • footerstring
      • headlinestring
      • firstMessageIdstringrequired
      • messagesarray of objectrequired

        At least 1 item. Up to 25 items.

        3 child fields
        • idstringrequired
        • textstringrequired

          Up to 500 characters.

        • buttonsarray of object

          At least 1 item. Up to 5 items.

          3 child fields
          • textstringrequired

            Up to 35 characters.

          • nextMessageIdstring
          • urlstring (URL)
    • eventobject
      1 child field
      • urnstringrequired

        Matches ^urn:li:event:\d+$.

    • thoughtLeaderobject
      1 child field
      • postUrnstringrequired

        Matches ^urn:li:(share|ugcPost):\d+$.

    Meta Ads settings (7 fields)
    • bidStrategystring

      One of LOWEST_COST_WITHOUT_CAP, LOWEST_COST_WITH_BID_CAP, COST_CAP, LOWEST_COST_WITH_MIN_ROAS.

    • bidAmountnumber
    • roasAverageFloornumber
    • dailyMinSpendTargetnumber
    • lifetimeMinSpendTargetnumber
    • customerLifecycleobject
      3 child fields
      • strategystringrequired

        One of all_customers, new_customers, new_customers_excluding_engaged.

      • existingCustomerAudienceIdsarray of string
      • engagedAudienceIdsarray of string
    • adScheduleobject

      At least 1 item.

      4 child fields
      • dayOfWeekstringrequired

        One of MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.

      • startHourintegerrequired

        0 to 23.

      • endHourintegerrequired

        1 to 24.

      • timezoneTypestring

        One of USER, ADVERTISER. Default USER.

  • dsaBeneficiarystring

    Up to 100 characters.

  • dsaPayorstring

    Up to 100 characters.

  • brandIdentityobject
    • displayNamestringrequired

      1 to 40 characters.

    • imageUrlstring (URL)required
  • identityIdstring
  • identityTypestring

    One of TT_USER, CUSTOMIZED_USER, BC_AUTH_TT.

  • smartPlusboolean
  • userOsarray of string

    At least 1 item.

  • userDevicearray of string

    At least 1 item.

  • isSkadnetworkAttributionboolean
  • campaignAttributionstring

    One of AEM, SKADNETWORK.

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

Example

curl -X POST "https://api.pozy.ai/v1/ads/create" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "accountId": "696e0b682d0a31188e7a2ba9",
  "adAccountId": "666219aad7bab67ace411e4f"
}'

Response

200 on success

  • validateOnlyboolean
  • appliedDefaultsobject
    • namestring
    • goalstring
    • budgetTypestring

      One of daily.

    • endDatestring
    • countriesarray of string
  • resultsarray of object
    • nodestring

      One of campaign, adSet, creative, ad, performanceMaxCampaign.

    • statusstring

      One of validated, skipped, unverified.

    • reasonstring
  • messagestring
200 response
{
  "validateOnly": true,
  "appliedDefaults": {
    "name": "Acme",
    "goal": "string",
    "budgetType": "daily",
    "endDate": "string",
    "countries": [
      "string"
    ]
  },
  "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:

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 campaignsPOSTCreate a standalone campaignPUTPause 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 treeGETGet campaign conversion goalsPATCHUpdate campaign conversion goals