Skip to main content
POST
/
brands
Create Brand
curl --request POST \
  --url https://api.scrunchai.com/v1/brands \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "website": "<string>",
  "description": "<string>",
  "alternative_names": [],
  "alternative_websites": [],
  "competitors": [],
  "personas": [],
  "key_topics": [],
  "status": "customer",
  "case_sensitive": false
}
'
{
  "id": 123
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
name
string
required
​
website
string
required
​
description
string
required
​
alternative_names
string[]
​
alternative_websites
string[]
​
competitors
APICompetitorInput · object[]
​
personas
APIPersonaInput · object[]
​
key_topics
string[]
​
status
enum<string>
default:customer
Available options:
lead,
prospect,
customer
​
case_sensitive
boolean
default:false

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

Response

Successful Response

​
id
integer
required