Delete a campaign
Deletes a campaign on its platform, including a campaign that never got any ads.
Only the campaign itself is sent to the platform. Meta, Google, TikTok, LinkedIn
and X delete it; OpenAI, Reddit and Pinterest have no campaign delete and archive
it instead (see below). Locally, all Ad documents for this campaign are marked
status: cancelled.
Empty campaigns. A campaign with zero ads has no local Ad documents
to resolve, so it is invisible to /v1/ads/tree and this endpoint would
404. That state is produced by the two-step create flow (campaign, then
ads via existingCampaignId) whenever Meta rejects the ad step. To
delete such a shell, send accountId in the body or the query string:
we skip the local lookup entirely and forward the delete to the platform
of that connection. Google, TikTok, LinkedIn, Pinterest and Reddit take the
ad account from the synced campaign (OpenAI needs none); when the campaign
was never synced (or is synced under several ad accounts) the answer is 409
invalid_resource_state on campaignId and nothing is deleted: sync the ad
account and retry. Before deleting on Google, TikTok, LinkedIn, Pinterest,
OpenAI or Reddit, Zernio asks the platform whether the campaign still holds
ad groups or ads (Google asset groups count; on LinkedIn, campaigns inside
the campaign group). If it does, or the platform cannot confirm it has none
(a TikTok Smart+ campaign), the answer is 409 invalid_resource_state on
campaignId and nothing is deleted: sync the ad account and delete the
campaign again so its ads are cancelled with it, or delete them on the
platform first. On X the ad account comes
from the synced campaign, which wins over adAccountId; when the campaign
was never synced, send adAccountId too. Before deleting, Zernio asks X
whether the campaign still holds undeleted line items (ads not synced
yet); if it does the answer is 409 invalid_field_value on campaignId
and nothing is deleted. Sync the ad account and retry when those line items
hold promoted posts; line items without promoted posts never sync, so delete
them in X Ads Manager first. accountId is ignored when the campaign does have ads.
Reddit Ads has no delete: the campaign is archived instead (configured_status
ARCHIVED), which stops delivery for good. Its ad groups and ads keep their own
switches but cannot deliver under an archived campaign.
OpenAI Ads has no delete either: the campaign is archived (state archive).
Its ad groups and ads are not touched on OpenAI.
Authorization
bearerAuth API key authentication: send your Zernio API key in the Authorization header, prefixed with Bearer.
In: header
Path Parameters
Platform campaign ID
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.adcampaigns.deleteAdCampaign({ path: { campaignId: 'campaign_abc123', }, body: { platform: 'facebook', },});console.log(data);{ "deleted": true, "adCount": 0}Duplicate a campaign
Copies a campaign with its ad sets, ads, creatives and targeting, created paused so you can review it before launch. Duplicates a campaign, including its ad sets, ads, creatives, and targeting by default (`deepCopy: true`). The copy is created paused so callers can review before launching. Per-platform implementation: - **Meta** uses the native `POST /{campaign-id}/copies` endpoint. - **TikTok** has no native copy primitive; Zernio walks the source graph (`/v2/campaign/get/`, `/v2/adgroup/get/`, `/v2/ad/get/`) and recreates each entity via the corresponding `/create/` endpoints, carrying over budget / targeting / bid_type / bid_price / deep_bid_type / creative fields. Spark Ad linkage (`tiktok_item_id`) is preserved. - **LinkedIn** has no native copy primitive; Zernio walks the source CampaignGroup → Campaigns → Creatives and recreates each entity, carrying over `type` / `costType` / `unitCost` / `optimizationTargetType` / `creativeSelection` / `objectiveType` / `format` / `dailyBudget` / `totalBudget` / `targetingCriteria` / `runSchedule` and every Creative's `content` object verbatim. `statusOption: INHERITED_FROM_SOURCE` is evaluated **per entity**: any Group / Campaign / Creative whose source is `ACTIVE` gets its clone activated too. Duplicating an ACTIVE campaign with `INHERITED_FROM_SOURCE` starts a second front of spend the moment the clone activates. The safe default is `PAUSED`. The new hierarchy is asynchronous to materialize in our DB, and we trigger sync discovery automatically. Set `syncAfter: false` to skip and poll `/v1/ads/tree` on your own cadence. Other platforms return 501 Not Implemented.
Pause or resume a campaign
Pauses or resumes a campaign, leaving the on/off switches of its ad sets and ads as they are. Writes the campaign's own on/off switch and nothing else, on every platform (Meta, TikTok, Google, LinkedIn campaign group, Pinterest, X, ChatGPT (OpenAI)). Its ad sets and ads keep their own switches: pausing stops their delivery through the campaign, and resuming lets each of them deliver again only if its own switch is on. An ad set or ad you paused individually stays paused; resume it with PUT /v1/ads/ad-sets/{adSetId}/status or PUT /v1/ads/{adId}/status. See the Status model in the Ad Campaigns tag. **Live read, then write.** The campaign's switch is read from the platform first. When that live read shows it already in the requested state nothing is written (`updated: 0`, `skipped: 1`, with the reason). Otherwise the switch is written (`updated: 1`), read back and stored, and the delivery status of the ads under it (up to 20) is re-read and stored, so an immediate GET returns what the platform now reports. A stored switch never skips a write, and when the platform cannot be read the write always goes out. On Meta the check reads the campaign's own `status`, so a delivery status such as `IN_PROCESS` or `WITH_ISSUES` does not force a write.