PATCH
/
v1
/
teams
/
{teamId}
/
brands
/
{brandId}
TypeScript client
import { OctosparkClient } from '@octospark/sdk'

const client = new OctosparkClient({
  token: process.env.OCTOSPARK_TOKEN
})

const response = await client.brands.updateBrand({
  teamId: process.env.OCTOSPARK_TEAM_ID ?? "teamId",
  brandId: process.env.OCTOSPARK_BRAND_ID ?? "brandId",
  body: {},
})
{
  "id": "<string>",
  "teamId": "<string>",
  "organizationId": "<string>",
  "name": "<string>",
  "isPrimary": true,
  "language": "<string>",
  "website": "<string>",
  "businessDescription": "<string>",
  "idealCustomer": "<string>",
  "customerLocation": "<string>",
  "colors": {
    "primary": "<string>",
    "secondary": "<string>",
    "accent": "<string>",
    "background": "<string>",
    "text": "<string>"
  },
  "contentTopics": [
    "<string>"
  ],
  "selectedSourceIds": [
    "<string>"
  ],
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

teamId
string
required

Team (workspace) id (UUID). Discover ids via the list teams endpoint or the agent context.

brandId
string
required

Brand id (UUID), as returned by the list brands and create brand endpoints.

Body

application/json
name
string

New display name for the brand.

Required string length: 1 - 200
language
string | null

Language the brand publishes in; send null to clear it.

Maximum string length: 4000
website
string | null

The brand's website URL; send null to clear it.

Maximum string length: 4000
businessDescription
string | null

Free-text description of what the business does; send null to clear it.

Maximum string length: 4000
idealCustomer
string | null

The audience generated content should be written for; send null to clear it.

Maximum string length: 4000
customerLocation
string | null

Where the audience is; send null to clear it.

Maximum string length: 4000
colors
object

The brand colour palette; send null to clear it.

contentTopics
string[]

Replacement list of topics the brand posts about (the whole list is replaced, not merged).

Maximum array length: 50

a string at most 120 character(s) long

Required string length: 1 - 120
selectedSourceIds
string<uuid>[]

Replacement list of content source ids this brand grounds on (the whole list is replaced, not merged).

Maximum array length: 200

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Response

Success

id
string
required
teamId
string
required
organizationId
string
required
name
string
required
isPrimary
boolean
required
language
string | null
required
website
string | null
required
businessDescription
string | null
required
idealCustomer
string | null
required
customerLocation
string | null
required
colors
object
required
contentTopics
string[]
required
selectedSourceIds
string[]
required
createdAt
string
required
updatedAt
string
required