Brand
Update Brand
Change parts of a workspace’s brand brain
PATCH
Update Brand
Changes parts of a workspace’s brand brain. Send only what changes. It saves the same way Settings → Brand does in the app. What you change is kept as yours: the brand brain never changes it again. See Kept as yours.The body must be JSON, sent with
Content-Type: application/json. A form body or any other content type is refused with 415, and JSON that won’t parse with 400. The query string is not read, so workspace_id goes in the body too.Request
The ID of the workspace, from List workspaces
Who they are. Any of
name, description, slogan, offer, audience, location, languages, industries and socials.How they sound. Any of
traits, formality, energy, humour, emoji, sentence_length, point_of_view, hashtags, cta_style, words_to_use, words_to_avoid, notes and examples.How to sound on each account: a list of
{ "account_id", "voice_note" }. Only the accounts you send change. Each must be a connected account of this workspace.The competitors they watch: up to 10
{ "name", "handles" }, where handles is a list of { "network", "handle" }. This replaces the whole list. On a paid plan a new handle is read at once. Its state is in watch on Get brand.Fields to clear, by path, such as
["voice.humour", "voice.formality"]. Each is cleared as if you sent it null, for a client that can’t send null. It takes any field you can set outside accounts; an account’s voice_note clears with null or "". Don’t also send a field you clear here.How a save works
- Inside a section, only the fields you send change. The rest stay as they are.
- A list is replaced whole. To add one word, send the full list with it.
nullclears a field. For a list,nulland[]both clear it.clearclears the fields it names, the same asnull. A field both sent and named inclearrefuses the save with422, at its place inclear(such asclear.0). A path inclearthat is no field you can clear comes back inmeta.ignored, such asclear.voice.mood.- Text is trimmed, and blank text is
null. Blank list items are dropped, and a repeat (in any case) is kept once. Hex colours are upper-cased. A handle loses its leading @. - A value the brand already has is no change, and isn’t checked. You can send back what you read.
- One bad value refuses the whole save with
422, and nothing is saved. - Keys that are no field a person sets are not saved. That means read-only fields (
identity.website,look.logo_url), the brand brain’s own fields (an account’sinsightandnumbers, an example’spost_id,viewsandurl) and unknown keys. They come back inmeta.ignored, with*for a place in a list, such asaccounts.*.insight.
Response
data is the brand object after the save. meta says what the save did:
The fields this save changed, as paths. An account’s field is named by its ID, such as
accounts.136.voice_note. Empty when nothing changed.Code Examples
Error Codes
The body is sent as JSON but isn’t valid JSON:
The body is not valid JSON. Nothing is saved.The key does not have the
brand:update permission, or the key’s person is not an owner or manager of the workspace: You do not have permission to edit workspace.workspace_id is missing, not a number, or a workspace the key’s person is not in (Invalid workspace ID.). Or a value is bad: each is named at its place in the body, such as voice.formality or accounts.0.account_id, with its limit. A field both sent and cleared is named at its place in clear. Nothing is saved.