SCscrunchai

Update Brand

Changed on

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}

Request

  • Base URL
    https://api.scrunchai.com/v1
  • Auth
    HTTP bearer

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.

excluded_websitesstring[] nullable

Websites whose citations must not count as owned by this brand or any of its competitors, e.g. 'advisors.example.com' when 'example.com' is configured. Brand-wide even when set on a competitor. Excluded citations are counted as third party, not removed. Omit to leave the stored list unchanged; send [] to clear it.

descriptionstring nullable

Short description of the brand.

key_topicsstring[] nullable

Full desired list of key topics. Topics whose names are unchanged are kept; a topic not in this list is taken off its prompts (the prompts are kept) and deleted, along with its content briefs. Its content drafts are kept but unfiled, and those written for the whole topic can no longer be generated (409 topic_deleted).

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.

geo_countrystring nullable

ISO 3166-1 alpha-2 country the brand is primarily tracked in. Collection targets this country unless a prompt overrides it.

default_languagestring nullable

Lowercase ISO 639-1 default language for the brand's prompts (e.g. nl).

Response

Successful Response

idinteger required
namestring required
descriptionstring required
websitestring required
statusstring required
alternative_namesstring[]
excluded_namesstring[]
excluded_websitesstring[]
alternative_websitesstring[]
case_sensitiveboolean
key_topicsstring[]
geo_countrystring

ISO 3166-1 alpha-2 country the brand is tracked in.

default_languagestring nullable

ISO 639-1 default language for the brand's prompts.

Changes

  • 4b4d643d9de6Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 5a4623f60693Revision changes
    • info

      added the new optional request property ///

    • info

      added the new optional request property

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status