Ads · Ad Campaigns

Update a campaign

Updates a campaign.

PUThttps://api.pozy.ai/v1/ads/campaigns/{campaignId}

Facebook and Instagram, Google Workspace, TikTok, LinkedIn, Pinterest and X and 2 moreupdateAdCampaign

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
`campaignId`required	string

Request body

application/json, required

platformstringrequired
One of facebook, instagram, tiktok, linkedin, pinterest, google, twitter, openai, reddit.
accountIdstring
bidStrategyobject
bidAmountnumber
roasAverageFloornumber
portfolioBidStrategyIdstring
Matches ^\d+$.
allowSharedBudgetUpdateboolean
Default false.
targetImpressionShareobject
- locationstringrequired
  One of ANYWHERE_ON_PAGE, TOP_OF_PAGE, ABSOLUTE_TOP_OF_PAGE.
- percentnumberrequired
  At most 100.
- maxCpcnumberrequired
manualCpcobject
- maxCpcnumberrequired
networkSettingsobject
- searchPartnersboolean
- displayNetworkboolean
trackingUrlTemplatestring
finalUrlSuffixstring
sharedBudgetIdstring
Matches ^\d+$. Can be null.
budgetobject
- amountnumberrequired
- typestringrequired
  One of daily, lifetime.
namestring
Up to 255 characters.
platformSpecificDataobject
- spendCapnumber
  Can be null.

Example

curl -X PUT "https://api.pozy.ai/v1/ads/campaigns/65a3737dd8b11ea61f199e6e" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "platform": "facebook"
}'

const res = await fetch("https://api.pozy.ai/v1/ads/campaigns/65a3737dd8b11ea61f199e6e", {
  method: "PUT",
  headers: {
    Authorization: `Bearer ${process.env.POZY_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    platform: "facebook"
  }),
});
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.put(
    "https://api.pozy.ai/v1/ads/campaigns/65a3737dd8b11ea61f199e6e",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    json={
        "platform": "facebook",
    },
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

200 on success

updatedinteger
budgetobject
- amountnumberrequired
- typestringrequired
  One of daily, lifetime.
- amountMicrosstring
  Matches ^\d+$.
- explicitlySharedboolean
  Can be null.
- resourceNamestring
  Can be null.
- deliveryMethodstring
  Can be null.
budgetLevelstring
One of campaign.
bidStrategystring
One of LOWEST_COST_WITHOUT_CAP, LOWEST_COST_WITH_BID_CAP, COST_CAP, LOWEST_COST_WITH_MIN_ROAS.
bidAmountnumber
roasAverageFloornumber
portfolioBidStrategyIdstring
targetImpressionShareobject
- locationstringrequired
  One of ANYWHERE_ON_PAGE, TOP_OF_PAGE, ABSOLUTE_TOP_OF_PAGE.
- percentnumberrequired
  At most 100.
- maxCpcnumberrequired
manualCpcobject
- maxCpcnumberrequired
networkSettingsobject
- searchPartnersboolean
- displayNetworkboolean
trackingUrlTemplatestring
finalUrlSuffixstring
sharedBudgetIdstring
Can be null.
platformSpecificDataobject

200 response

{
  "updated": 1,
  "budget": {
    "amount": 12.5,
    "type": "daily",
    "amountMicros": "string",
    "explicitlyShared": true,
    "resourceName": "Acme",
    "deliveryMethod": "string"
  },
  "budgetLevel": "campaign",
  "bidStrategy": "LOWEST_COST_WITHOUT_CAP",
  "bidAmount": 12.5,
  "roasAverageFloor": 12.5,
  "portfolioBidStrategyId": "657ef37139bac4c6428f5f10",
  "targetImpressionShare": {
    "location": "ANYWHERE_ON_PAGE",
    "percent": 12.5,
    "maxCpc": 12.5
  },
  "manualCpc": {
    "maxCpc": 12.5
  },
  "networkSettings": {
    "searchPartners": true,
    "displayNetwork": true
  },
  "trackingUrlTemplate": "https://pozy.ai/media/example-1.jpg",
  "finalUrlSuffix": "https://pozy.ai/media/example-1.jpg",
  "sharedBudgetId": "6251639fc36f449486902b2e",
  "platformSpecificData": {}
}

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.

More in Ad Campaigns

GETList ads GETList Google Ads recommendations POSTApply Google Ads recommendations POSTDismiss Google Ads recommendations GETList portfolio bid strategies POSTCreate portfolio bid strategy PATCHUpdate portfolio bid strategy GETList shared budgets POSTCreate a shared budget GETList Search keywords POSTAdd Search ad-group keywords PATCHPause or enable a Search keyword DELRemove a Search keyword GETList campaigns POSTCreate a standalone campaign PUTPause or resume a campaign GETRead a campaign's ad schedule (dayparting)PUTReplace a campaign's ad schedule (dayparting)GETRead a campaign's current bidding GETGet live campaign details DELDelete a campaign GETList campaign-level negative keywords PUTReplace campaign-level negative keywords POSTPause or resume many campaigns POSTDuplicate a campaign GETRead a Google campaign's device, location, excluded location, and language targeting PUTEdit a Google campaign's device, location, excluded location, or language targeting GETList ad sets POSTCreate a standalone ad group POSTDuplicate an ad set POSTDuplicate an ad GETGet live ad-set details PUTUpdate an ad set DELDelete an ad set GETRead a Reddit ad group's targeting and schedule PUTPause or resume a single ad set GETGet campaign tree GETGet daily account metrics GETGet ad details PUTUpdate ad DELCancel an ad PUTPause or resume a single ad GETList campaign assets POSTAttach campaign assets PUTUpdate campaign assets DELRemove campaign assets GETList ad-group assets POSTAttach ad-group assets PUTUpdate ad-group assets DELRemove ad-group assets GETRead the platform's review verdict for an ad GETReview status of each creative in a TikTok Smart+ ad GETList ads that need attention POSTDismiss an ads alert GETReview status of every TikTok Smart+ ad of an advertiser GETList campaign negative lists PUTReplace campaign negative lists POSTBoost post as ad GETList Performance Max asset groups POSTCreate a Performance Max asset group GETGet a Performance Max asset group PATCHUpdate a Performance Max asset group DELRemove a Performance Max asset group POSTLink or unlink asset group assets PUTReplace an asset group's listing-group tree POSTCreate standalone ad GETGet campaign conversion goals PATCHUpdate campaign conversion goals