Sign in
latestOpenAPI 3.1.02026-08-204087139.4 KB

c4fe20c603a3

Update Brand

Partially update a brand. Only fields included in the request body are modified. For competitors and personas, the provided list uses replace semantics: the list you send represents the complete desired state. Include an id to update an existing record, omit id to create a new one. Any existing competitors or personas not included in the list will be archived. To leave competitors or personas unchanged, omit the field entirely from the request.

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.

excluded_namesstring[] nullable

Phrases that must never count as a mention of this brand, e.g. brand "Caliber" excluding "Caliber Auto Wash".

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[]
excluded_namesstring[]
alternative_websitesstring[]
case_sensitiveboolean
key_topicsstring[]