Import live campaign
Import a live campaign (one that exists in the ad account on the ad platform but NOT yet in Koast) into a Koast batch, so it becomes both reportable AND extendable.
Tool name: import-live-campaign.
Import a live campaign (one that exists in the ad account on the ad platform but NOT yet in Koast) into a Koast batch, so it becomes both reportable AND extendable. Idempotent, if a Koast batch already wraps this providerCampaignId, returns its campaignLaunchId and alreadyExisted: true instead of duplicating. Use this WHENEVER the user asks for metrics, fatigue, or details on a campaign returned by listAccountCampaigns that has no Koast batch yet, call this FIRST to obtain a campaignLaunchId, then run normal launch-scoped reporting tools against it. THIS IS ALSO HOW YOU ADD TO A LIVE CAMPAIGN: import it, then addAdset / addAds against the returned campaignLaunchId and launchCampaign, and the new ad sets and ads are published INTO the existing campaign rather than into a new one. Never tell a user that adding an ad set to a live campaign has to be done in the ad platform's own manager, it does not.
When to use
Wrap a live campaign that is not yet in Koast in a Koast batch, so it becomes reportable and can be extended. The first step for BOTH "report on this live campaign" and "add an ad set / ads to this live campaign", once imported, addAdset and addAds work against it and launchCampaign publishes into the same campaign. Idempotent: re-running on the same providerCampaignId returns the existing batch instead of duplicating. It creates a Koast batch, so it is a write: unavailable in plan mode and refused to a read-only credential.
Access
| Property | Value |
|---|---|
| Required scope | write |
| Publishes | No |
| Read-only | No |
| Destructive | No |
| Idempotent | Yes |
| Open world | Yes |
Input
| Field | Type | Required | Description |
|---|---|---|---|
providerCampaignId | string | Yes | Campaign id on the ad platform (the raw id from listAccountCampaigns rows). |
brandId | integer | No | Optional Koast brand id. When omitted, uses the brand from the current context. Required from a multi-account dashboard chat. |
title | string | No | Optional batch title; defaults to the campaign name server-side. At most 200 characters. |
Output
| Field | Type | Required | Description |
|---|---|---|---|
campaignLaunchId | string | Yes | |
alreadyExisted | boolean | Yes | |
title | string | null | Yes |
REST equivalent
POST /v1/brands/{brandId}/launches/import, Import live campaign. CLI: koast import-live-campaign.