Skip to main content
POST
/
brands
/
{brand_id}
/
competitors
Create Competitor
curl --request POST \
  --url https://api.scrunchai.com/v1/brands/{brand_id}/competitors \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "alternative_names": [],
  "websites": []
}
'
{
  "id": 123,
  "name": "<string>",
  "alternative_names": [],
  "websites": []
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

brand_id
integer
required

Body

application/json

Input model for creating a competitor.

name
string
required

Display name of the competitor.

Minimum string length: 1
alternative_names
string[]

Alternative names or aliases for the competitor.

websites
string<uri>[]

Website URLs associated with the competitor.

Required string length: 1 - 2083

Response

Successful Response

id
integer
required
name
string
required
alternative_names
string[]
websites
string[]