Skip to main content
PATCH
Save brand positioning

Authorizations

Authorization
string
header
required

A workspace API key issued in Settings → Developer, sent as Bearer sk_….

Body

application/json
positioning
string

The brand positioning statement. Sending it authors a new version.

Required string length: 3 - 2000
audience
string | null
productDescription
string | null
tone
string | null
competitors
string[]
excludedTopics
string[]
rawIntent
string

Verbatim free-text the author typed.

notConfusedWith
object[]

Other products that share the brand's name (for example Jam at jam.dev for Jam at spreadjam.com). Replaces the stored list; [] clears it. Each needs a domain or terms. Answers about them stop counting as mentions from the next scan; stored answers are not rewritten.

Maximum array length: 10

Response

The new active version.

version
integer
required
Example:

4

superseded
boolean
required

Whether a prior active version was superseded.

notConfusedWith
object[]

The stored list, when the request sent notConfusedWith.