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

library_placement_delete

Delete a Placement of your organization. A live Variation that names it refuses the delete.

Ask to remove a slot of your own. The agent deletes the Placement. It leaves each group that holds it, and the groups stay.

“Delete the partner feed placement.”

A live Variation that names the Placement refuses the delete with placement_in_use, and nothing changes. The agent then clears or changes the Placement of that Variation with library_variation_update, and calls this tool again. A global Placement is read-only.

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

Reference

Delete a Placement of your organization. The Placement leaves each group that holds it, and the groups stay. A live Variation that names the Placement refuses the delete with placement_in_use, and nothing changes. Clear or change the Placement of that Variation with library_variation_update first. A global row (isGlobal is true) is held by AdCrunch for each organization. You read it and use it. A change of a global row, and a delete of it, answer not_found.

Input

Argument Type Required Description
placement_id string yes The id of a Placement (plm_…). library_placement_list gives it. A Placement of AdCrunch (isGlobal) and a Placement of your organization both work.

Output

A successful call returns this object in structuredContent.

Field Type Always present Description
deleted true yes
placementId string yes The id of the deleted Placement, plm_….

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
  • placement_in_use
  • 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:

{
  "placement_id": "plm_4b8d27"
}

The result, in structuredContent:

{
  "deleted": true,
  "placementId": "plm_4b8d27"
}

Was this page helpful?