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

variation_remove

Remove a Variation from its Creative. The Asset stays in your Library.

Ask to take a file out of an ad idea. The agent removes the Variation, and the file stays in your Library as an Asset.

“Take the square banner out of the Spring sale creative.”

The agent reads the Creative with library_creative_get, finds the Variation of that file, and calls this tool. You then see the Creative with one Variation less. A Variation has no update: to use another file, the agent removes the Variation and adds a new one.

This tool is part of the job Bring your own creative.

Reference

Remove one Variation from its Creative. The Asset stays in the Library, and no ad account changes. A Variation has no update: to use another Asset in the Creative, remove the Variation and add a new one with variation_add.

Input

Argument Type Required Description
creative_id string yes The id of a Creative of your Library (crv_…). library_creative_list gives it.
variation_id string yes The id of a Variation of that Creative (var_…). variation_list gives it.

Output

A successful call returns this object in structuredContent.

Field Type Always present Description
removed true yes
variationId string yes The id of the removed Variation, var_….

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 library: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:

{
  "creative_id": "crv_5e2a19",
  "variation_id": "var_8c3f60"
}

The result, in structuredContent:

{
  "removed": true,
  "variationId": "var_8c3f60"
}

Was this page helpful?