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

campaign_plan_update

Edit a Campaign Plan. A real change returns an approved Campaign Plan to draft.

Ask the agent to change the fields of a Campaign Plan: its name, its brand, its envelope, its dates or its body. The body is one markdown document: why this split, and how the result will be judged. The agent sends only what changes.

“Move the end of the spring sale Campaign Plan to 30 June, and raise the envelope to €7,500.”

The agent reads the Campaign Plan, then calls campaign_plan_update with the revision of the Campaign Plan that it read. You see the Campaign Plan as it is now. When the Campaign Plan was approved, a real change returns it to draft. When another change came first, AdCrunch refuses the write, and the agent reads the Campaign Plan again. The currency cannot change after a Line Item has a budget. To change a Line Item, the agent calls line_item_update.

Plan a campaign walks the whole job.

Reference

Update a Campaign Plan. Omit a field to leave it alone; send null to clear it. Pass base_revision from campaign_plan_get. Any real change returns an approved plan to draft — an approval refers to particular content and cannot outlive it; a write that changes nothing leaves the approval standing. The currency is refused once any Line Item carries a budget or a cost target (cpa, cpc or cpm), because re-denominating a costed plan would silently reinterpret every number in it. A Campaign Plan is AdCrunch’s own planning document — it is not a campaign on Meta or Google. For those, use list_campaigns and get_campaign.

Input

Argument Type Required Description
base_revision integer yes The revision of the Campaign Plan, as you last read it via campaign_plan_get. Guards against writing over a change somebody else made since.
body string, 1 to 50000 characters or null no The whole new body, in markdown: it replaces the old one. Pass null to clear it. A change reverts an approved plan to draft.
brand_name string or null no Re-point the plan at another brand by slug; null unlinks it. Refused while a Line Item still names a persona of the current brand.
campaign_plan_name string yes The Campaign Plan slug — its stable per-organization handle.
currency string, 3 characters no ISO 4217. Refused once any Line Item carries a budget — nothing is ever converted.
description string no
end_date string or null no null makes the plan always-on, which also flips every inheriting line from a total to a daily rate.
name string no
slug string no A new slug handle — a deliberate rename.
start_date string or null no
total_budget number, at least 0 or null no null means “no declared constraint”, not zero.

Output

A successful call returns this object in structuredContent.

Field Type Always present Description
campaignPlan object yes The Campaign Plan as it is now, with the number of its Line Items. line_item_list gives the Line Items.
campaignPlan.allocation object yes The money of the Campaign Plan. AdCrunch calculates it on each read and does not store it.
campaignPlan.allocation.allocated number or null yes The sum of the Line Item budgets, in whole units of the currency. null when the Line Items with a budget do not share a unit.
campaignPlan.allocation.comparable boolean yes false when the Line Items with a budget mix totals and daily rates. Then no sum exists: say “not comparable”, and do not add the budgets.
campaignPlan.allocation.unallocated number or null yes The envelope less the allocated sum. It can be negative. null when the envelope is not set, when the Line Items do not share a unit, or when the unit is daily.
campaignPlan.allocation.unit one of total, daily or null yes The unit that the Line Items with a budget share. null when no Line Item has a budget, or when the Line Items do not share a unit.
campaignPlan.assignees array of object yes The current members who are accountable for the record, oldest first, at most 10. An Assignee grants no access.
campaignPlan.assignees[].id string yes The usr_… id of the member.
campaignPlan.assignees[].name string yes The name of the member.
campaignPlan.body string or null yes The long markdown document of the Campaign Plan: the argument for the split, how the result is judged, and anything else a reviewer reads. null when nobody wrote it.
campaignPlan.brand object or null yes The Brand that the Campaign Plan is for, or null when it has no Brand or its Brand was deleted.
campaignPlan.brand.name string yes The display name of the Brand.
campaignPlan.brand.slug string yes The slug of the Brand. Each tool takes it as brand_name.
campaignPlan.brandId string or null yes The Brand that the Campaign Plan is for, brd_…, or null.
campaignPlan.commentCount number yes The number of live Comments on the Campaign Plan, replies included. List them with campaign_plan_comment_list.
campaignPlan.createdAt number yes Milliseconds since the Unix epoch, UTC.
campaignPlan.createdBy string yes The user who created the Campaign Plan, usr_….
campaignPlan.currency string yes ISO 4217. Each amount of the Campaign Plan and of its Line Items is in whole units of this currency. It cannot change after a Line Item has a budget.
campaignPlan.description string yes One sentence that tells the Campaign Plan apart in a list.
campaignPlan.endDate string or null yes The last day of the Campaign Plan, or null. With no end date, the Campaign Plan is always on, and the budget of a Line Item with no end date of its own is a daily rate.
campaignPlan.id string yes The id of the Campaign Plan, cpl_….
campaignPlan.lineItemCount number yes The number of live Line Items of the Campaign Plan. List them with line_item_list.
campaignPlan.name string yes The display name.
campaignPlan.revision number yes The revision of the Campaign Plan. It increments when the Campaign Plan changes. Send it as base_revision to campaign_plan_update or campaign_plan_delete. A Line Item has a revision of its own.
campaignPlan.slug string yes The slug of the Campaign Plan. Each tool takes it as campaign_plan_name.
campaignPlan.startDate string or null yes The first day of the Campaign Plan, or null.
campaignPlan.status one of draft, approved yes approved when a person approved the content at this revision in the AdCrunch console. It is a record, not a gate: the provider write tools do not check it. A real change to the Campaign Plan, or a Line Item that is added or deleted, returns it to draft.
campaignPlan.totalBudget number or null yes The envelope: the money that you have, in whole units of currency. null means no declared limit, not zero.
campaignPlan.updatedAt number or null yes When the Campaign Plan last changed, or null when it never changed.

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
  • invalid_slug
  • invalid_currency
  • invalid_amount
  • invalid_window
  • persona_not_in_brand
  • currency_frozen
  • revision_mismatch
  • slug_conflict
  • organization_unentitled
  • forbidden
  • invalid_request
  • internal_error

Scope

The token must hold campaign_plan: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.
  • Closed world. The tool reads and writes the data of AdCrunch only.

Example

The arguments:

{
  "base_revision": 3,
  "campaign_plan_name": "spring-sale",
  "end_date": "2026-06-30",
  "total_budget": 7500
}

The result, in structuredContent:

{
  "campaignPlan": {
    "allocation": {
      "allocated": 2500,
      "comparable": true,
      "unallocated": 5000,
      "unit": "total"
    },
    "assignees": [],
    "body": "## Why this split\n\nMeta carries the reach. One Line Item keeps the budget in one place.\n\n## How it will be judged\n\nRevenue in the window, against the spring of 2025.",
    "brand": {
      "name": "Acme",
      "slug": "acme"
    },
    "brandId": "brd_6a9c33",
    "commentCount": 2,
    "createdAt": 1768435200000,
    "createdBy": "usr_5d2b71",
    "currency": "EUR",
    "description": "The spring sale of Acme, on Meta, in France and Belgium.",
    "endDate": "2026-06-30",
    "id": "cpl_4e1a08",
    "lineItemCount": 1,
    "name": "Spring Sale 2026",
    "revision": 4,
    "slug": "spring-sale",
    "startDate": "2026-03-01",
    "status": "draft",
    "totalBudget": 7500,
    "updatedAt": 1769644800000
  }
}

Was this page helpful?