Skip to content
AdCrunch
Esc
↑↓navigate↵open⌘Jpreview
On this page

meta_update_status

Pause, resume or archive a Meta campaign, ad set or ad.

Ask to pause, resume or archive a campaign, an ad set or an ad on Meta. Resume starts delivery, and so it starts spend. A resume and an archive wait for you to confirm them in the AdCrunch console. A pause does not wait. AdCrunch checks that the object is in the ad account of the advertiser, and it keeps the status that the change replaces.

Pause the FR BE 25-54 ad set on Northwind.

The agent calls meta_update_status, then get_mutation_status, and you see whether Meta applied the change. Change what runs on Meta tells why archive is almost permanent.

Reference

Available on: Meta

Pause, resume, or archive a Meta campaign, ad set, or ad on a live ad account. Runs asynchronously: returns a mutationId immediately — call get_mutation_status with it to see whether the change succeeded, and to get the status that it replaced as priorValue. AdCrunch refuses an object that is not in this ad account with not_found. ACTIVE resumes delivery (spends money); PAUSED stops it; ARCHIVED retires the object and is close to permanent — an archived object leaves Ads Manager’s default views and cannot be returned to delivery, so use it only to retire something that should not exist, never to pause it. ACTIVE on an object that is not active, and ARCHIVED on an object that is not archived, wait for a person: A person must confirm this change in the AdCrunch console before it reaches Meta, and get_mutation_status reports awaiting_confirmation until then. Give the consoleUrl of the answer to the user. Do not call get_mutation_status in a loop while the change waits: it waits up to 24 hours, and then it expires with no change. PAUSED never waits.

Input

Argument Type Required Description
advertiserId string yes Advertiser account ID (acc_<id>). Must belong to the active organization.
id string yes The Meta object ID of the campaign, ad set, or ad, digits only.
level one of campaign, adset, ad yes Which level the id refers to.
status one of ACTIVE, PAUSED, ARCHIVED yes ACTIVE resumes delivery; PAUSED stops it; ARCHIVED retires the object near-permanently (it cannot be brought back into delivery). Prefer PAUSED unless the object should not exist at all.

Output

A successful call returns this object in structuredContent.

Field Type Always present Description
consoleUrl string yes The page of this change in the AdCrunch console. When get_mutation_status reports awaiting_confirmation, give this URL to the user: a person must confirm the change there before it reaches Meta. You cannot confirm it.
mutationId string yes The id of the change. The change has not reached Meta yet. Give this id to get_mutation_status to find out how the change ended.

Failure codes

A failed call has isError set, and structuredContent.error holds one of these codes. Errors describes the shape of a failed call.

  • not_found
  • provider_not_connected
  • missing_write_access
  • organization_unentitled
  • forbidden
  • invalid_request
  • internal_error

Scope

The token must hold mutation:write. Auth & scopes lists each scope.

Annotations

A client reads these hints. A hint that the tool does not declare has the default value of the MCP specification.

  • Writes. The tool can change data.
  • Destructive. The tool can make a change that you cannot undo. A client can ask you to confirm before it calls the tool.
  • Not idempotent. A second call with the same arguments can change more.
  • Open world. The tool reaches a system outside AdCrunch, such as an ad platform.

Example

The arguments:

{
  "advertiserId": "acc_1485443900032333",
  "id": "120215678901234890",
  "level": "adset",
  "status": "PAUSED"
}

The result, in structuredContent:

{
  "consoleUrl": "https://console.adcrunch.dev/activity/mut_k3x9q2v7m4n8p1r5t6w0y2z4",
  "mutationId": "mut_k3x9q2v7m4n8p1r5t6w0y2z4"
}

Was this page helpful?