Brands

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 slug changes only when you send a slug: a new name alone never moves the handle. The answer is 409 with error=revision_mismatch if the Brand changed after you read it. It is 409 with error=slug_conflict if another Brand already holds the slug you send.

patch/context/brands/{slug}

Request

Base URL: https://api.adcrunch.dev
URL: https://api.adcrunch.dev/context/brands/{slug}
Auth: HTTP bearer

Path parameters

slugstring required

Request body

base_revisioninteger required

The revision last read via GET — guards concurrent edits.

descriptionstring

guidelinesstring nullable

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

identitystring nullable

Positioning and mission; null clears it.

logo_document_idstring nullable

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

messagingstring nullable

Key messages; null clears the section.

namestring

slugstring

Optional new slug handle (a deliberate rename).

voicestring nullable

Tone of voice; null clears the section.

website_urlstring uri nullable

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

Example request

{
  "base_revision": 4,
  "guidelines": "- Name the distance, never the \"journey\".\n- Claim the kilometres the shoe is tested to, and no more.\n- Do not compare the shoe to a named competitor.",
  "logo_document_id": "doc_5e2b41",
  "messaging": "- One shoe, a thousand kilometres.\n- Resole it twice, and keep running on it.\n- Sold direct, so the price is the cost of the shoe."
}

Response

The Brand as it now stands, at the next revision. Send that one back on your next edit.

createdAtnumber required

Milliseconds since the Unix epoch, UTC.

createdBystring required

descriptionstring required

guidelinesstring nullable required

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

idstring required

identitystring nullable required

Positioning, mission, what is on offer.

logoDocumentIdstring nullable required

The Document this Brand nominates as its logo.

messagingstring nullable required

Key messages, value propositions, proof points.

namestring required

revisionnumber required

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

slugstring required

updatedAtnumber nullable required

Milliseconds since the Unix epoch, UTC.

voicestring nullable required

Tone and personality.

websiteUrlstring nullable required

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

Example response

{
  "createdAt": 1790000000000,
  "createdBy": "usr_4d8b12",
  "description": "Running shoes sold direct to the runner, made to last a thousand kilometres.",
  "guidelines": "- Name the distance, never the \"journey\".\n- Claim the kilometres the shoe is tested to, and no more.\n- Do not compare the shoe to a named competitor.",
  "id": "brd_6a9c33",
  "identity": "Acme makes one running shoe and sells it direct. The promise is a thousand kilometres on the same pair, and a resole rather than a replacement.",
  "logoDocumentId": "doc_5e2b41",
  "messaging": "- One shoe, a thousand kilometres.\n- Resole it twice, and keep running on it.\n- Sold direct, so the price is the cost of the shoe.",
  "name": "Acme",
  "revision": 5,
  "slug": "acme",
  "updatedAt": 1790086400000,
  "voice": "Plain and measured. Short sentences. No superlative the shoe cannot earn.",
  "websiteUrl": "https://acme.example"
}

Changes

No recorded changes to this operation across all 1 revision of this API.