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

brand_delete

Delete a brand and all that it holds. The revision that the agent read stops the delete of a brand that changed.

Ask to delete a brand. The agent deletes the brand and all that it holds.

“Delete the brand Acme Trail.”

The agent reads the brand with brand_get, and then calls brand_delete. Your client can ask you to confirm first. You then see that the brand is gone.

The job guide Describe a brand shows each step of the job.

Reference

Delete a brand and all the context authored on it. Pass base_revision (from brand_get) — the delete is rejected if the brand changed since you read it. The slug becomes free to re-use afterwards.

Input

Argument Type Required Description
base_revision integer yes The revision you last read via brand_get. Guards against deleting a concurrently-edited brand.
brand_name string yes The brand slug identifying which brand to delete.

Output

A successful call returns this object in structuredContent.

Field Type Always present Description
deleted true yes The brand is deleted.
slug string yes The slug of the deleted brand.

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
  • revision_mismatch
  • forbidden
  • invalid_request
  • internal_error

Scope

The token must hold brand: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:

{
  "base_revision": 4,
  "brand_name": "acme"
}

The result, in structuredContent:

{
  "deleted": true,
  "slug": "acme"
}

Was this page helpful?