Update ad

Patch one or more fields on an ad. Status, budget, targeting, and creative changes are propagated to the platform.

Per-platform support:

Meta (Facebook + Instagram): all fields supported.
TikTok: status, budget, targeting (via /v2/adgroup/update/), and creative (via /v2/ad/update/ patch-style — headline is ignored, body becomes ad_text).
Pinterest / X / LinkedIn / Google: status + budget only. Sending targeting or creative returns 501 with code unsupported_platform_operation.

Authorization

AuthorizationBearer <token>

API key authentication - use your Zernio API key as a Bearer token

In: header

Path Parameters

adIdstring

Request Body

status?string

Value in"active" | "paused"

budget?

targeting?

Meta + TikTok only. Pinterest / X / LinkedIn / Google return 501.

creative?

Replace the ad's creative. Meta + TikTok only.

Meta: requires headline, body, callToAction, linkUrl, imageUrl. The ad's existing creative is replaced via a new /act_X/adcreatives upload + ad update. The old creative is retained on the ad account for historical reporting.
TikTok: patch-style. Pass any subset; headline is ignored (TikTok creatives have no headline slot). body becomes the in-feed ad_text; linkUrl becomes landing_page_url; videoUrl triggers a fresh upload.

name?string

Rename the ad. Now propagated to Meta (POST /{ad-id}); non-Meta platforms return 501.

Lengthlength <= 255

Response Body

application/json

import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.ads.updateAd({  path: {    adId: 'ad_abc123',  },  body: {    status: 'active',    budget: {      amount: 0,      type: 'daily',    },    targeting: {      ageMin: 13,      ageMax: 13,      countries: [        'string',      ],    },  },});console.log(data);

{
  "ad": {
    "_id": "string",
    "name": "string",
    "platform": "facebook",
    "status": "active",
    "adType": "boost",
    "goal": "engagement",
    "isExternal": true,
    "budget": {
      "amount": 0,
      "type": "daily"
    },
    "metrics": {
      "spend": 0,
      "impressions": 0,
      "reach": 0,
      "clicks": 0,
      "ctr": 0,
      "cpc": 0,
      "cpm": 0,
      "engagement": 0,
      "conversions": 0,
      "costPerConversion": 0,
      "actions": {
        "link_click": 160,
        "post_engagement": 300,
        "offsite_conversion.fb_pixel_purchase": 42
      },
      "actionValues": {
        "offsite_conversion.fb_pixel_purchase": 2456.78,
        "offsite_conversion.fb_pixel_add_to_cart": 980.5
      },
      "purchaseValue": 0,
      "roas": 0,
      "lastSyncedAt": "2019-08-24T14:15:22Z"
    },
    "platformAdId": "string",
    "platformAdAccountId": "string",
    "platformCampaignId": "string",
    "platformAdSetId": "string",
    "campaignName": "string",
    "adSetName": "string",
    "platformObjective": "OUTCOME_SALES",
    "optimizationGoal": "OFFSITE_CONVERSIONS",
    "platformAdAccountName": "Zernio - previously Late",
    "platformCreatedAt": "2019-08-24T14:15:22Z",
    "bidStrategy": "LOWEST_COST_WITHOUT_CAP",
    "bidAmount": 5,
    "roasAverageFloor": 2,
    "promotedObject": {
      "custom_event_type": "PURCHASE",
      "pixel_id": "string",
      "page_id": "string",
      "application_id": "string",
      "product_set_id": "string"
    },
    "creative": {
      "thumbnailUrl": "string",
      "imageUrl": "string",
      "videoId": "string",
      "videoUrl": "string",
      "objectType": "string",
      "objectStoryId": "string",
      "effectiveObjectStoryId": "string",
      "effectiveInstagramMediaId": "string",
      "instagramUserId": "string",
      "instagramPermalinkUrl": "string",
      "mediaUrls": [
        "string"
      ],
      "body": "string",
      "googleHeadline": "string",
      "googleDescription": "string",
      "linkUrl": "string",
      "pinterestImageUrl": "string",
      "pinterestTitle": "string",
      "pinterestDescription": "string"
    },
    "targeting": {},
    "schedule": {
      "startDate": "2019-08-24T14:15:22Z",
      "endDate": "2019-08-24T14:15:22Z"
    },
    "rejectionReason": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  },
  "message": "string"
}

Empty

{
  "error": "Unauthorized"
}

{
  "error": "Not found"
}

Empty

Update ad

Patch one or more fields on an ad. Status, budget, targeting, and creative changes are propagated to the platform.

Per-platform support:

Meta (Facebook + Instagram): all fields supported.
TikTok: status, budget, targeting (via /v2/adgroup/update/), and creative (via /v2/ad/update/ patch-style — headline is ignored, body becomes ad_text).
Pinterest / X / LinkedIn / Google: status + budget only. Sending targeting or creative returns 501 with code unsupported_platform_operation.

Authorization

AuthorizationBearer <token>

API key authentication - use your Zernio API key as a Bearer token

In: header

Path Parameters

adIdstring

Request Body

status?string

Value in"active" | "paused"

budget?

targeting?

Meta + TikTok only. Pinterest / X / LinkedIn / Google return 501.

creative?

Replace the ad's creative. Meta + TikTok only.

Meta: requires headline, body, callToAction, linkUrl, imageUrl. The ad's existing creative is replaced via a new /act_X/adcreatives upload + ad update. The old creative is retained on the ad account for historical reporting.
TikTok: patch-style. Pass any subset; headline is ignored (TikTok creatives have no headline slot). body becomes the in-feed ad_text; linkUrl becomes landing_page_url; videoUrl triggers a fresh upload.

name?string

Rename the ad. Now propagated to Meta (POST /{ad-id}); non-Meta platforms return 501.

Lengthlength <= 255

Response Body

application/json

import Zernio from '@zernio/node';

const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });

const { data } = await zernio.ads.updateAd({
  path: {
    adId: 'ad_abc123',
  },
  body: {
    status: 'active',
    budget: {
      amount: 0,
      type: 'daily',
    },
    targeting: {
      ageMin: 13,
      ageMax: 13,
      countries: [
        'string',
      ],
    },
  },
});
console.log(data);

import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.ads.updateAd({  path: {    adId: 'ad_abc123',  },  body: {    status: 'active',    budget: {      amount: 0,      type: 'daily',    },    targeting: {      ageMin: 13,      ageMax: 13,      countries: [        'string',      ],    },  },});console.log(data);

{
  "ad": {
    "_id": "string",
    "name": "string",
    "platform": "facebook",
    "status": "active",
    "adType": "boost",
    "goal": "engagement",
    "isExternal": true,
    "budget": {
      "amount": 0,
      "type": "daily"
    },
    "metrics": {
      "spend": 0,
      "impressions": 0,
      "reach": 0,
      "clicks": 0,
      "ctr": 0,
      "cpc": 0,
      "cpm": 0,
      "engagement": 0,
      "conversions": 0,
      "costPerConversion": 0,
      "actions": {
        "link_click": 160,
        "post_engagement": 300,
        "offsite_conversion.fb_pixel_purchase": 42
      },
      "actionValues": {
        "offsite_conversion.fb_pixel_purchase": 2456.78,
        "offsite_conversion.fb_pixel_add_to_cart": 980.5
      },
      "purchaseValue": 0,
      "roas": 0,
      "lastSyncedAt": "2019-08-24T14:15:22Z"
    },
    "platformAdId": "string",
    "platformAdAccountId": "string",
    "platformCampaignId": "string",
    "platformAdSetId": "string",
    "campaignName": "string",
    "adSetName": "string",
    "platformObjective": "OUTCOME_SALES",
    "optimizationGoal": "OFFSITE_CONVERSIONS",
    "platformAdAccountName": "Zernio - previously Late",
    "platformCreatedAt": "2019-08-24T14:15:22Z",
    "bidStrategy": "LOWEST_COST_WITHOUT_CAP",
    "bidAmount": 5,
    "roasAverageFloor": 2,
    "promotedObject": {
      "custom_event_type": "PURCHASE",
      "pixel_id": "string",
      "page_id": "string",
      "application_id": "string",
      "product_set_id": "string"
    },
    "creative": {
      "thumbnailUrl": "string",
      "imageUrl": "string",
      "videoId": "string",
      "videoUrl": "string",
      "objectType": "string",
      "objectStoryId": "string",
      "effectiveObjectStoryId": "string",
      "effectiveInstagramMediaId": "string",
      "instagramUserId": "string",
      "instagramPermalinkUrl": "string",
      "mediaUrls": [
        "string"
      ],
      "body": "string",
      "googleHeadline": "string",
      "googleDescription": "string",
      "linkUrl": "string",
      "pinterestImageUrl": "string",
      "pinterestTitle": "string",
      "pinterestDescription": "string"
    },
    "targeting": {},
    "schedule": {
      "startDate": "2019-08-24T14:15:22Z",
      "endDate": "2019-08-24T14:15:22Z"
    },
    "rejectionReason": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  },
  "message": "string"
}

Empty

{
  "error": "Unauthorized"
}

{
  "error": "Not found"
}

Empty

Update ad

200application/json

400

401application/json

404application/json

501

Update ad

200application/json

400

401application/json

404application/json

501

application/json

application/json

application/json

application/json

application/json

application/json