Create a Brand

Creates a Brand in your organization. Every narrative section is optional, because you write a Brand one part at a time. AdCrunch makes the slug from the name. To set a different slug, send one. The answer is 409 if the slug already exists in your organization.

POST/context/brands

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.

Request body

requiredapplication/json

descriptionstringrequired

One-line summary — what agents read to pick this Brand.

min length 1 · max length 500

guidelinesstring

Do's and don'ts, guardrails, claims to avoid (markdown).

min length 1

identitystring

Who the brand is: positioning, mission, offering (markdown).

min length 1

messagingstring

Key messages, value propositions, proof points (markdown).

min length 1

namestringrequired

Display name.

min length 1 · max length 120

slugstring

Optional explicit slug handle; normalized to kebab-case. Defaults to one derived from the name.

max length 120

voicestring

Tone of voice and personality (markdown).

min length 1

website_urlstring<uri>

The Brand's public site — a locator like the slug, not a section. Setting it does nothing on its own; reading it is a separate, explicit call.

Responses

201

The Brand as created, at revision 1. Every unwritten section comes back null, which is a normal state rather than an error.

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.

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.

409

Another Brand in this organization already holds that slug. error is slug_conflict. A Skill may share it — each aggregate is addressed through its own surface.

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

The name and slug together contain no letter or digit. error is invalid_slug.

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 POST "https://api.pr-701.adcrunch.dev/context/brands" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "description": "Running shoes sold direct to the runner, made to last a thousand kilometres.",
  "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.",
  "name": "Acme",
  "slug": "acme",
  "voice": "Plain and measured. Short sentences. No superlative the shoe cannot earn.",
  "website_url": "https://acme.example"
}'

const response = await fetch("https://api.pr-701.adcrunch.dev/context/brands", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"description\": \"Running shoes sold direct to the runner, made to last a thousand kilometres.\",\n  \"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.\",\n  \"name\": \"Acme\",\n  \"slug\": \"acme\",\n  \"voice\": \"Plain and measured. Short sentences. No superlative the shoe cannot earn.\",\n  \"website_url\": \"https://acme.example\"\n}"
});

import requests

response = requests.post(
    "https://api.pr-701.adcrunch.dev/context/brands",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"description\": \"Running shoes sold direct to the runner, made to last a thousand kilometres.\",\n  \"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.\",\n  \"name\": \"Acme\",\n  \"slug\": \"acme\",\n  \"voice\": \"Plain and measured. Short sentences. No superlative the shoe cannot earn.\",\n  \"website_url\": \"https://acme.example\"\n}",
)

Response

{
  "createdAt": 1790000000000,
  "createdBy": "usr_4d8b12",
  "description": "Running shoes sold direct to the runner, made to last a thousand kilometres.",
  "guidelines": null,
  "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": null,
  "messaging": null,
  "name": "Acme",
  "revision": 1,
  "slug": "acme",
  "updatedAt": null,
  "voice": "Plain and measured. Short sentences. No superlative the shoe cannot earn.",
  "websiteUrl": "https://acme.example"
}

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

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

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

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

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