Update a Brand

Updates a Brand. Send the base_revision you read. Omit a narrative section to keep it. Send null to clear it. The answer is 409 with error=revision_mismatch if the Brand changed after you read it. It is 409 with error=slug_conflict if the new name gives a slug that already exists.

PATCH/context/brands/{slug}

Authorization

AuthorizationBearer token · headerrequired

Send Authorization: Bearer <credential>. Two credentials work.

An API key (acr_…) is what a server integration uses. Create one in the AdCrunch console under Settings → API keys — see https://docs.adcrunch.dev/account/api-keys. A key is bound to the organization that was active when you created it, and it keeps acting on that organization whatever you do later. It carries the permissions of the member who created it.

A session issued by the AdCrunch sign-in flow also works, which is how the console calls this service from the browser.

Either way the organization comes from the credential. There is no organization parameter.

Path parameters

slugstringrequired

Request body

requiredapplication/json

base_revisionintegerrequired

The revision last read via GET — guards concurrent edits.

min -9007199254740991 · max 9007199254740991

descriptionstring

min length 1 · max length 500

guidelinesstring | null

Do's and don'ts; null clears the section.

min length 1

identitystring | null

Positioning and mission; null clears it.

min length 1

logo_document_idstring | null

Nominate one of the Brand's documents as its logo; null clears the nomination.

matches ^doc_[\s\S]{0,}$

messagingstring | null

Key messages; null clears the section.

min length 1

namestring

min length 1 · max length 120

slugstring

Optional new slug handle (a deliberate rename).

max length 120

voicestring | null

Tone of voice; null clears the section.

min length 1

website_urlstring<uri> | null

The Brand's public site; null clears it. Changing it starts no read.

Responses

200

The Brand as it now stands.

createdAtnumberrequired

Milliseconds since the Unix epoch, UTC.

createdBystringrequired

descriptionstringrequired

guidelinesstring | nullrequired

Do’s and don’ts, claims to avoid.

idstringrequired

identitystring | nullrequired

Positioning, mission, what is on offer.

logoDocumentIdstring | nullrequired

The Document this Brand nominates as its logo.

messagingstring | nullrequired

Key messages, value propositions, proof points.

namestringrequired

revisionnumberrequired

Increments on every write. Send it back as base_revision to edit; a stale one answers 409.

slugstringrequired

updatedAtnumber | nullrequired

Milliseconds since the Unix epoch, UTC.

voicestring | nullrequired

Tone and personality.

websiteUrlstring | nullrequired

The brand’s public site. A locator only — its contents are not stored.

401

No credential, or one that does not resolve. Send an API key or a session. 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

error tells the two conflicts apart. revision_mismatch means somebody wrote first — re-read, re-apply, and send currentRevision back. slug_conflict means the rename collides.

Any of:

object

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.

object

slugstringrequired

The slug that is already taken.

errorstringrequired

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

Allowed:slug_conflict

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.

422

Two codes share this status. invalid_slug: the new slug has no letter or digit. invalid_logo: the nominated logo is not one of this Brand’s own finished documents.

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.

Request

curl -X PATCH "https://api.adcrunch.dev/context/brands/string" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "base_revision": -9007199254740991,
  "description": "string",
  "guidelines": "string",
  "identity": "string",
  "logo_document_id": "string",
  "messaging": "string",
  "name": "string",
  "slug": "string",
  "voice": "string",
  "website_url": "http://example.com"
}'

const response = await fetch("https://api.adcrunch.dev/context/brands/string", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"base_revision\": -9007199254740991,\n  \"description\": \"string\",\n  \"guidelines\": \"string\",\n  \"identity\": \"string\",\n  \"logo_document_id\": \"string\",\n  \"messaging\": \"string\",\n  \"name\": \"string\",\n  \"slug\": \"string\",\n  \"voice\": \"string\",\n  \"website_url\": \"http://example.com\"\n}"
});

import requests

response = requests.patch(
    "https://api.adcrunch.dev/context/brands/string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"base_revision\": -9007199254740991,\n  \"description\": \"string\",\n  \"guidelines\": \"string\",\n  \"identity\": \"string\",\n  \"logo_document_id\": \"string\",\n  \"messaging\": \"string\",\n  \"name\": \"string\",\n  \"slug\": \"string\",\n  \"voice\": \"string\",\n  \"website_url\": \"http://example.com\"\n}",
)

Response

{
  "createdAt": 0,
  "createdBy": "string",
  "description": "string",
  "guidelines": "string",
  "id": "string",
  "identity": "string",
  "logoDocumentId": "string",
  "messaging": "string",
  "name": "string",
  "revision": 0,
  "slug": "string",
  "updatedAt": 0,
  "voice": "string",
  "websiteUrl": "string"
}

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

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

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

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

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