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

line_item_creative_remove

Take a Creative off one Line Item, and keep it in the Campaign Plan.

Ask to stop the use of a Creative on one Line Item.

“Take the summer creative off the retargeting line.”

The agent calls line_item_creative_remove with the slug of the Campaign Plan, the id of the Line Item and the id of the Creative. The answer is the Creatives of the Line Item after the call.

  • The Creative stays in the pool of the Campaign Plan, and on each other Line Item that uses it. To take it out of the plan, the agent calls campaign_plan_creative_remove.
  • 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 the Line Item does not use gives the same result.
  • The Line Item does not change. Its revision stays, and a validated Line Item stays validated.

Reference

Take a Creative off one Line Item. The answer is the Creatives of the Line Item after the call. The Creative stays in the pool of the Campaign Plan, and on each other Line Item that uses it. To take it out of the Campaign Plan, call campaign_plan_creative_remove. The Creative stays in the Library, and no ad account changes: an ad that was built from the Creative is not touched. Removing a Creative that the Line Item does not use 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.
line_item_id string yes The Line Item id, as returned by line_item_list.

Output

A successful call returns this object in structuredContent.

Field Type Always present Description
creatives array of object yes The Creatives of the Library that the Line Item uses, oldest first, at most 20. Build the ads of the Line Item from them. 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.

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",
  "line_item_id": "lni_2d9e77"
}

The result, in structuredContent:

{
  "creatives": []
}

Was this page helpful?