Sign in

v1

latestOpenAPI 3.1.02026-07-263370112.1 KB

Update Brand

Partially update a brand. Only fields included in the request body are modified. For competitors and personas, the provided list represents the full desired state: include an id to update an existing record, omit id to create a new one, and any existing records not in the list are archived.

If you submit a persona without an id and its name matches a previously archived persona on the same brand, the archived persona is reactivated (its status returns to active and its description is updated) instead of creating a duplicate. This avoids unique-name conflicts when reusing a name that was previously archived.

patch/brands/{brand_id}

Path parameters

brand_idinteger required

Request body

namestring nullable

Brand display name.

alternative_namesstring[] nullable

Alternative names or aliases for the brand.

websitestring nullable

Primary website URL.

alternative_websitesstring[] nullable

Additional website URLs for the brand.

descriptionstring nullable

Short description of the brand.

key_topicsstring[] nullable

Key topics associated with the brand.

status'lead' | 'prospect' | 'customer' nullable

Brand status. Allowed values: lead, customer.

case_sensitiveboolean nullable

When true, the brand name and alternative_names are matched against AI responses with exact case. When false, matching is case-insensitive.

Response

Successful Response

idinteger required
namestring required
descriptionstring required
websitestring required
statusstring required
alternative_namesstring[]

Alternative names or aliases for the brand.

alternative_websitesstring[]
key_topicsstring[]
case_sensitiveboolean