Delete a Brand

Deletes a Brand. Send the base_revision you read, in the query string. The delete carries its Personas, its Documents and its advertiser attachments with it. The slug becomes free again. The answer is 409 with error=revision_mismatch if the Brand changed after you read it.

DELETE/context/brands/{slug}

Authorization

AuthorizationBearer token · headerrequired

Send Authorization: Bearer <credential>.

Use an API key (acr_…), from the AdCrunch console under Settings → API keys.

The credential names the organization, and no operation takes an organization parameter.

See https://docs.adcrunch.dev/api/authentication.

Path parameters

slugstringrequired

Query parameters

base_revisionintegerrequired

min -9007199254740991 · max 9007199254740991

Responses

204

Deleted, with its Personas, its Documents and its advertiser attachments. The document bytes are dropped from storage too, so a deleted Brand’s guidelines PDF stops being readable at its URL. Its Campaign Plans stay, pointing at a tombstone the read path handles.

400

The request does not match the schema of this operation: a field is missing or has the wrong type, or the body is not valid JSON. error is invalid_request, and issues names each field. Nothing was changed.

issuesobject[]required

One entry for each field that does not match.

Show properties

Array of object

instringrequired

The part of the request that holds the field.

Allowed:bodycookieheadersparamsquery

messagestringrequired

A sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.

pathstringrequired

A JSON Pointer into that part of the request, such as /filename. An empty string is the whole part.

errorstringrequired

A stable code for the failure. This is the field to branch on. It does not change for a given failure.

Allowed:invalid_request

messagestringrequired

A sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.

401

No API key, or one that does not resolve. See the security scheme. error is unauthorized.

errorstringrequired

A stable code for the failure. This is the field to branch on. It does not change for a given failure.

Allowed:unauthorized

messagestringrequired

A sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.

403

The caller does not hold brand:write. error is forbidden.

errorstringrequired

A stable code for the failure. This is the field to branch on. It does not change for a given failure.

Allowed:forbidden

messagestringrequired

A sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.

404

No Brand with that slug. error is not_found.

errorstringrequired

A stable code for the failure. This is the field to branch on. It does not change for a given failure.

messagestringrequired

A sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.

409

The Brand moved since you read it. error is revision_mismatch.

currentRevisionnumberrequired

The revision the row holds now. Re-read, re-apply your edit on top, and send this back as base_revision.

errorstringrequired

A stable code for the failure. This is the field to branch on. It does not change for a given failure.

Allowed:revision_mismatch

messagestringrequired

A sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.

Request

curl -X DELETE "https://api.pr-701.adcrunch.dev/context/brands/string?base_revision=-9007199254740991" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://api.pr-701.adcrunch.dev/context/brands/string?base_revision=-9007199254740991", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.delete(
    "https://api.pr-701.adcrunch.dev/context/brands/string?base_revision=-9007199254740991",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

Deleted, with its Personas, its Documents and its advertiser attachments. The document bytes are dropped from storage too, so a deleted Brand’s guidelines PDF stops being readable at its URL. Its **Campaign Plans stay**, pointing at a tombstone the read path handles.

{
  "issues": [
    {
      "in": "body",
      "message": "string",
      "path": "string"
    }
  ],
  "error": "invalid_request",
  "message": "string"
}

{
  "error": "unauthorized",
  "message": "string"
}

{
  "error": "forbidden",
  "message": "string"
}

{
  "error": "string",
  "message": "string"
}

{
  "currentRevision": 0,
  "error": "revision_mismatch",
  "message": "string"
}