Skip to main content
PATCH
Update brand profile

Authorizations

Authorization
string
header
required

A Searchable API key, created under Manage Account → Integrations → API Keys. Send as Authorization: Bearer sea_xxxxx. Every key carries one or more scopes (read, write, admin) and may optionally be bound to a single project — see Getting started.

Path Parameters

projectId
string<uuid>
required

The project id.

Body

application/json

A subset of knowledge-base brand fields, and the Tone / Writing Style and Memory documents, to update. Every field is optional; only supplied fields are changed. Does not touch connectedEntities, eeatData, or the project's default location.

name
string
description
string

A longer factual description. The app doesn't show it; topic assignment and some other analyses read it.

positioning
string

What the brand does: the app's Brand Context box, read by prompt generation and most analyses.

category
string
influence
enum<string>

Where the brand sells (the app's Geographic reach). Does not change the default location.

Available options:
global,
national-global,
nationwide,
regional,
local
language
string

A language code the app offers, e.g. en-GB.

websiteUrl
string
caseSensitive
boolean

The app's Exact match only: count only mentions with the brand name's exact spelling and capitalization.

brandNameDisambiguation
string
topics
string[]
tone
string

The Knowledge Base's Tone / Writing Style document: free-form markdown on the brand's voice, adjectives, phrases to avoid and language to include, which the app's agents follow when they write. Replaces the whole document; an empty string clears it.

Maximum string length: 100000
memory
string

The Knowledge Base's Memory document: free-form markdown facts and preferences the app's agents keep in mind. Replaces the whole document; an empty string clears it.

Maximum string length: 100000

Response

Brand profile updated.

success
boolean
required
action
enum<string>
required

Whether the knowledge-base row was created, updated, or left unchanged (no field in the request differed from the stored value). The tone and memory documents are not part of that row; see updatedDocuments.

Available options:
created,
updated,
unchanged
updatedDocuments
enum<string>[]
required

The writing documents this request replaced; empty when it sent neither.

Available options:
tone,
memory