SCscrunchai

Create Brand

Changed on

Create a new brand

post/brands

Request

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

Request body

namestring required
alternative_namesstring[]
excluded_namesstring[]

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

excluded_websitesstring[]

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.

websitestring required
alternative_websitesstring[]
descriptionstring required
key_topicsstring[]
status'lead' | 'prospect' | 'customer'
case_sensitiveboolean

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

geo_countrystring

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

geo_statestring nullable

State or region for locality-sensitive brands.

geo_citystring nullable

City for locality-sensitive brands.

geo_latitudenumber nullable

Latitude used for locality-sensitive collection. Requires geo_longitude.

geo_longitudenumber nullable

Longitude used for locality-sensitive collection. Requires geo_latitude.

default_languagestring nullable

Lowercase ISO 639-1 default language for the brand's prompts (e.g. nl). Falls back to en when omitted.

Response

Successful Response

idinteger required

Changes

  • 4b4d643d9de6Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

  • 5a4623f60693Revision changes
    • info

      added the new optional request property //

    • info

      added the new optional request property