SCscrunchai

Create Competitor

Changed on

Create a new competitor

post/brands/{brand_id}/competitors

Request

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

Path parameters

brand_idinteger required

Request body

namestring required

Display name of the competitor.

alternative_namesstring[]

Alternative names or aliases for the competitor.

excluded_namesstring[]

Phrases that must never count as a mention of this competitor, e.g. a competitor '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.

websitesstring[]

Website URLs associated with the competitor.

case_sensitiveboolean

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

Response

Successful Response

idinteger required
namestring required
alternative_namesstring[]
excluded_namesstring[]
excluded_websitesstring[]
websitesstring[]
case_sensitiveboolean

Changes

  • 5a4623f60693Revision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

  • 1d487d04437fRevision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status