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

library_placement_group_delete

Delete a Placement group of your organization. Its Placements stay in the Library.

Ask to remove a group. The agent deletes it. The Placements of the group stay in the Library, and no Variation changes.

“Delete the Vertical group.”

A global group is read-only, and a delete of it answers not_found.

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

Reference

Delete a Placement group of your organization. The Placements of the group stay in the Library. 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
group_id string yes The id of a Placement group (plg_…). library_placement_group_list gives it.

Output

A successful call returns this object in structuredContent.

Field Type Always present Description
deleted true yes
groupId string yes The id of the deleted group, plg_….

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:

{
  "group_id": "plg_9e1c53"
}

The result, in structuredContent:

{
  "deleted": true,
  "groupId": "plg_9e1c53"
}

Was this page helpful?