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

campaign_plan_creative_remove

Take a Creative out of a Campaign Plan and off each of its Line Items.

Ask to remove a Creative from a Campaign Plan.

“Remove the winter creative from the spring sale plan.”

The agent calls campaign_plan_creative_remove with the slug of the Campaign Plan and the id of the Creative. The answer is the pool after the call.

  • The Creative leaves the pool and every Line Item of the plan. Before the call, the agent tells you which Line Items lose the Creative.
  • To take the Creative off one Line Item only, the agent calls line_item_creative_remove. The Creative then stays in the pool.
  • The Creative stays in your Library. No ad account changes, and an ad that was built from the Creative is not touched.
  • The call is idempotent. A Creative that is not in the pool gives the same result.
  • The plan does not change. Its revision stays, and an approved plan stays approved.

Reference

Take a Creative out of the pool of a Campaign Plan. The Creative also leaves every Line Item of the Campaign Plan. The answer is the pool after the call. To take the Creative off one Line Item and keep it in the pool, call line_item_creative_remove. campaign_plan_creative_list shows the Line Items that use the Creative: tell the user which Line Items lose it before you call this Tool. The Creative stays in the Library, and no ad account changes. Removing a Creative that is not in the pool changes nothing. The call does not change the revision or the status of the Campaign Plan or of a Line Item: a validated Line Item stays validated.

Input

Argument Type Required Description
campaign_plan_name string yes The Campaign Plan slug — its stable per-organization handle.
creative_id string yes The id of a Creative of the Library, crv_…. library_creative_list gives the Creatives of the organization.

Output

A successful call returns this object in structuredContent.

Field Type Always present Description
creatives array of object yes The Creatives of the pool, oldest first, at most 50: the whole pool, in one answer. A Creative that was deleted in the Library is not listed.
creatives[].id string yes The id of the Creative in the Library, crv_….
creatives[].name string or null yes The name of the Creative, or null when it has none.
creatives[].variationCount number yes The number of Variations of the Creative. library_creative_get gives them.
creatives[].lineItemIds array of string yes The ids of the Line Items of the Campaign Plan that use the Creative. Empty when the Creative is not assigned to a Line Item yet.

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
  • 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.
  • Idempotent. A second call with the same arguments changes nothing more.
  • Closed world. The tool reads and writes the data of AdCrunch only.

Example

The arguments:

{
  "campaign_plan_name": "spring-sale",
  "creative_id": "crv_8c2e47"
}

The result, in structuredContent:

{
  "creatives": []
}

Was this page helpful?