Create a Brand
Creates a Brand in your organization. The body 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.
/context/brandsAuthorizationBearer token · headerrequiredSend 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.
application/jsonbodystringWhat an agent reads to act for this Brand (markdown), at most 50,000 characters. Suggested headings: Identity, Voice, Guidelines, Messaging. The headings are advice, not schema.
descriptionstringrequiredOne-line summary — what agents read to pick this Brand.
namestringrequiredDisplay name.
slugstringOptional explicit slug handle; normalized to kebab-case. Defaults to one derived from the name.
website_urlstring<uri>The Brand's public site — a locator like the slug, not part of the body. Setting it does nothing on its own; reading it is a separate, explicit call.
The Brand as created, at revision 1. An unwritten body comes back null, which is a normal state rather than an error.
assigneesobject[]requiredThe current members who are accountable for the record, oldest first, at most 10. An Assignee grants no access. A member who left is not listed.
Show propertiesHide properties
objectidstringrequiredThe usr_… id of the member.
namestringrequiredThe name of the member.
bodystring | nullrequiredWhat an agent reads to act for this Brand, in markdown, or null when nobody wrote it. A listing answers hasBody, never the body.
createdAtnumberrequiredMilliseconds since the Unix epoch, UTC.
createdBystringrequireddescriptionstringrequiredidstringrequiredlogoDocumentIdstring | nullrequiredThe Document this Brand nominates as its logo.
namestringrequiredrevisionnumberrequiredIncrements on every write. Send it back as base_revision to edit; a stale one answers 409.
slugstringrequiredupdatedAtnumber | nullrequiredMilliseconds since the Unix epoch, UTC.
websiteUrlstring | nullrequiredThe brand’s public site. A locator only — its contents are not stored.
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[]requiredOne entry for each field that does not match.
Show propertiesHide properties
objectinstringrequiredThe part of the request that holds the field.
bodycookieheadersparamsquerymessagestringrequiredA sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.
pathstringrequiredA JSON Pointer into that part of the request, such as /filename. An empty string is the whole part.
errorstringrequiredA stable code for the failure. This is the field to branch on. It does not change for a given failure.
invalid_requestmessagestringrequiredA sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.
No API key, or one that does not resolve. See the security scheme. error is unauthorized.
errorstringrequiredA stable code for the failure. This is the field to branch on. It does not change for a given failure.
unauthorizedmessagestringrequiredA sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.
The organization has no active subscription. An owner subscribes at paywallUrl. error is organization_unentitled.
paywallUrlstring<uri>requiredThe page where an owner of the organization subscribes. Show it to the person.
errorstringrequiredA stable code for the failure. This is the field to branch on. It does not change for a given failure.
organization_unentitledmessagestringrequiredA sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.
The caller does not hold brand:write. error is forbidden.
errorstringrequiredA stable code for the failure. This is the field to branch on. It does not change for a given failure.
forbiddenmessagestringrequiredA sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.
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.
slugstringrequiredThe slug that is already taken.
errorstringrequiredA stable code for the failure. This is the field to branch on. It does not change for a given failure.
slug_conflictmessagestringrequiredA sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.
The name and slug together contain no letter or digit. error is invalid_slug.
errorstringrequiredA stable code for the failure. This is the field to branch on. It does not change for a given failure.
messagestringrequiredA sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.