Unarchive Campaigns
unarchive_campaignsPut archived campaigns back, with a result per campaign.
An unarchived campaign is visible again under its name and no
experiment restarts. The exception is a campaign that was waiting
for its audiences to launch when it was archived: unarchiving
resumes that launch and it starts spending, so such a campaign
is only unarchived once its id is in confirm_pending_launch_ids.
KEYWORDS: unarchive, restore, undo archive, recover, put back, campaign
WHEN TO USE:
- The user asks to restore or unarchive campaigns, or to undo an
archive
- To find archived campaigns, call list_wizard_campaigns with
visibility ARCHIVED
Each campaign is processed on its own, so one that cannot be put
back does not stop the others. `results` holds one entry per
campaign with its `outcome`:
- unarchived
- not_archived: it is not archived; nothing changed
- not_in_account: no campaign with that id in this account
- native_imported: imported from an ad channel account, which is
never unarchived here
- pending_launch: unarchiving would resume its pending launch;
ask the user, then call again with only the campaigns the user
agreed to in confirm_pending_launch_ids
- name_taken: another visible campaign now holds its name, and
`holder` names it. Offer to rename the holder; once the user
agrees and it is renamed, unarchive again. Without a `holder`,
the archived campaign may hold the name itself. Never rename an
archived campaign: its name is what unarchive restores, so
renaming it blocks its own unarchive.
- not_attempted: the call stopped early (a rejected session or
rate limiting) before reaching it
- unknown: the platform's answer was lost; check the campaign
before trying again
- error: the platform refused it; `message` says why
PARAMETERS:
- campaign_ids (required): 1 to 50 campaign ids
- confirm_pending_launch_ids (optional): the campaigns, among
campaign_ids, whose pending launch the user agreed to resumeInput Schema
| Name | Required | Description | Default |
|---|---|---|---|
| campaign_ids | Yes | The ids of the campaigns to unarchive (1 to 50) | |
| confirm_pending_launch_ids | No | Campaigns, among campaign_ids, whose pending launch (and spend) the user agreed to resume |