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

Documentation Index

Fetch the complete documentation index at: https://developers.scrunch.com/llms.txt

Use this file to discover all available pages before exploring further.

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

Partial update payload for a brand.

Only fields present in the request body are updated. Omitted fields are left unchanged. For competitors and personas, the provided list replaces the current state: existing records not included in the list are archived.

name
string | null

Brand display name.

alternative_names
string[] | null

Alternative names or aliases for the brand.

website
string | null

Primary website URL.

alternative_websites
string[] | null

Additional website URLs for the brand.

description
string | null

Short description of the brand.

competitors
APICompetitorPatchInput · object[] | null

Full desired list of competitors. Existing competitors not in this list are archived.

personas
APIPersonaPatchInput · object[] | null

Full desired list of personas. Existing personas not in this list are archived.

key_topics
string[] | null

Key topics associated with the brand.

status
enum<string> | null

Brand status. Allowed values: lead, customer.

Available options:
lead,
prospect,
customer
case_sensitive
boolean | null

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

Response

Successful Response

id
integer
required
name
string
required
description
string
required
website
string
required
status
string
required
alternative_names
string[]

Alternative names or aliases for the brand.

alternative_websites
string[]
competitors
APICompetitorListing · object[]
personas
APIPersonaListing · object[]
key_topics
string[]
case_sensitive
boolean
default:false