PEpeec
Project

Update Brand

Update a brand within a project. Changes to name, regex, or aliases trigger a background recalculation of metrics. While recalculation is in progress, further updates to these fields are blocked (409 Conflict) until it completes.

patch/brands/{brand_id}

Request

  • Base URL
    https://api.peec.ai/customer/v1
  • URL
    https://api.peec.ai/customer/v1/brands/{brand_id}
  • Auth
    • API key in header X-API-Key
    • or API key in query parameter api_key
    • or HTTP bearer

Path parameters

brand_idstring required

Request body

namestring

Triggers metric recalculation when changed

regexstring nullable

Triggers metric recalculation when changed

aliasesstring[]

Triggers metric recalculation when changed

domainsstring[]
colorstring

Hex color like #1A2B3C

Response

Brand updated successfully

object required

Brand updated successfully

Changes

No recorded changes to this operation across all 3 revisions of this API.