Update Competitor

Update Competitor

curl --request PATCH \
  --url https://api.example.com/api/v1/brands/{brand_id}/competitors/{comp_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "website_url": "<string>",
  "description": "<string>",
  "notes": "<string>",
  "industry": "<string>",
  "country": "<string>",
  "content_url": "<string>",
  "youtube_channel_url": "<string>",
  "is_starred": true,
  "social_links": {}
}
'

import requests

url = "https://api.example.com/api/v1/brands/{brand_id}/competitors/{comp_id}"

payload = {
    "name": "<string>",
    "website_url": "<string>",
    "description": "<string>",
    "notes": "<string>",
    "industry": "<string>",
    "country": "<string>",
    "content_url": "<string>",
    "youtube_channel_url": "<string>",
    "is_starred": True,
    "social_links": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    website_url: '<string>',
    description: '<string>',
    notes: '<string>',
    industry: '<string>',
    country: '<string>',
    content_url: '<string>',
    youtube_channel_url: '<string>',
    is_starred: true,
    social_links: {}
  })
};

fetch('https://api.example.com/api/v1/brands/{brand_id}/competitors/{comp_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/brands/{brand_id}/competitors/{comp_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'website_url' => '<string>',
    'description' => '<string>',
    'notes' => '<string>',
    'industry' => '<string>',
    'country' => '<string>',
    'content_url' => '<string>',
    'youtube_channel_url' => '<string>',
    'is_starred' => true,
    'social_links' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/brands/{brand_id}/competitors/{comp_id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"website_url\": \"<string>\",\n  \"description\": \"<string>\",\n  \"notes\": \"<string>\",\n  \"industry\": \"<string>\",\n  \"country\": \"<string>\",\n  \"content_url\": \"<string>\",\n  \"youtube_channel_url\": \"<string>\",\n  \"is_starred\": true,\n  \"social_links\": {}\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.example.com/api/v1/brands/{brand_id}/competitors/{comp_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"website_url\": \"<string>\",\n  \"description\": \"<string>\",\n  \"notes\": \"<string>\",\n  \"industry\": \"<string>\",\n  \"country\": \"<string>\",\n  \"content_url\": \"<string>\",\n  \"youtube_channel_url\": \"<string>\",\n  \"is_starred\": true,\n  \"social_links\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/brands/{brand_id}/competitors/{comp_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"website_url\": \"<string>\",\n  \"description\": \"<string>\",\n  \"notes\": \"<string>\",\n  \"industry\": \"<string>\",\n  \"country\": \"<string>\",\n  \"content_url\": \"<string>\",\n  \"youtube_channel_url\": \"<string>\",\n  \"is_starred\": true,\n  \"social_links\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "seed_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "seed_origin": "public",
  "is_seed": true,
  "override": {
    "added": false,
    "removed": false,
    "starred": true,
    "edited_fields": [
      "<string>"
    ]
  },
  "advertiser_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "advertiser_resolved_at": "2023-11-07T05:31:56Z",
  "identity_resolved": false,
  "canonical_domain": "<string>",
  "website_url": "<string>",
  "homepage_url": "<string>",
  "website_header_image_url": "<string>",
  "description": "<string>",
  "notes": "<string>",
  "industry": "<string>",
  "brand_classification": {
    "primary_industry": "<string>",
    "industries": [
      "<string>"
    ],
    "business_models": [
      "<string>"
    ],
    "version": "<string>",
    "source": "<string>",
    "classified_at": "2023-11-07T05:31:56Z",
    "needs_review": false
  },
  "country": "<string>",
  "content_url": "<string>",
  "youtube_channel_url": "<string>",
  "is_starred": false,
  "social_links": {},
  "analysis_data": {},
  "brand_intelligence_advertiser_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "active_paid_media_platforms": [
    "<string>"
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "source": "seo_discovery"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

PATCH

api

brands

{brand_id}

competitors

{comp_id}

Update Competitor

curl --request PATCH \
  --url https://api.example.com/api/v1/brands/{brand_id}/competitors/{comp_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "website_url": "<string>",
  "description": "<string>",
  "notes": "<string>",
  "industry": "<string>",
  "country": "<string>",
  "content_url": "<string>",
  "youtube_channel_url": "<string>",
  "is_starred": true,
  "social_links": {}
}
'

import requests

url = "https://api.example.com/api/v1/brands/{brand_id}/competitors/{comp_id}"

payload = {
    "name": "<string>",
    "website_url": "<string>",
    "description": "<string>",
    "notes": "<string>",
    "industry": "<string>",
    "country": "<string>",
    "content_url": "<string>",
    "youtube_channel_url": "<string>",
    "is_starred": True,
    "social_links": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    website_url: '<string>',
    description: '<string>',
    notes: '<string>',
    industry: '<string>',
    country: '<string>',
    content_url: '<string>',
    youtube_channel_url: '<string>',
    is_starred: true,
    social_links: {}
  })
};

fetch('https://api.example.com/api/v1/brands/{brand_id}/competitors/{comp_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/brands/{brand_id}/competitors/{comp_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'website_url' => '<string>',
    'description' => '<string>',
    'notes' => '<string>',
    'industry' => '<string>',
    'country' => '<string>',
    'content_url' => '<string>',
    'youtube_channel_url' => '<string>',
    'is_starred' => true,
    'social_links' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/brands/{brand_id}/competitors/{comp_id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"website_url\": \"<string>\",\n  \"description\": \"<string>\",\n  \"notes\": \"<string>\",\n  \"industry\": \"<string>\",\n  \"country\": \"<string>\",\n  \"content_url\": \"<string>\",\n  \"youtube_channel_url\": \"<string>\",\n  \"is_starred\": true,\n  \"social_links\": {}\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.example.com/api/v1/brands/{brand_id}/competitors/{comp_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"website_url\": \"<string>\",\n  \"description\": \"<string>\",\n  \"notes\": \"<string>\",\n  \"industry\": \"<string>\",\n  \"country\": \"<string>\",\n  \"content_url\": \"<string>\",\n  \"youtube_channel_url\": \"<string>\",\n  \"is_starred\": true,\n  \"social_links\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/brands/{brand_id}/competitors/{comp_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"website_url\": \"<string>\",\n  \"description\": \"<string>\",\n  \"notes\": \"<string>\",\n  \"industry\": \"<string>\",\n  \"country\": \"<string>\",\n  \"content_url\": \"<string>\",\n  \"youtube_channel_url\": \"<string>\",\n  \"is_starred\": true,\n  \"social_links\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "seed_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "seed_origin": "public",
  "is_seed": true,
  "override": {
    "added": false,
    "removed": false,
    "starred": true,
    "edited_fields": [
      "<string>"
    ]
  },
  "advertiser_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "advertiser_resolved_at": "2023-11-07T05:31:56Z",
  "identity_resolved": false,
  "canonical_domain": "<string>",
  "website_url": "<string>",
  "homepage_url": "<string>",
  "website_header_image_url": "<string>",
  "description": "<string>",
  "notes": "<string>",
  "industry": "<string>",
  "brand_classification": {
    "primary_industry": "<string>",
    "industries": [
      "<string>"
    ],
    "business_models": [
      "<string>"
    ],
    "version": "<string>",
    "source": "<string>",
    "classified_at": "2023-11-07T05:31:56Z",
    "needs_review": false
  },
  "country": "<string>",
  "content_url": "<string>",
  "youtube_channel_url": "<string>",
  "is_starred": false,
  "social_links": {},
  "analysis_data": {},
  "brand_intelligence_advertiser_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "active_paid_media_platforms": [
    "<string>"
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "source": "seo_discovery"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Path Parameters

brand_id

string<uuid>

required

comp_id

string<uuid>

required

Body

application/json

name

string | null

Required string length: 1 - 200

website_url

string | null

Required string length: 5 - 500

description

string | null

notes

string | null

industry

string | null

Required string length: 1 - 120

country

string | null

Required string length: 1 - 8

content_url

string | null

Required string length: 5 - 500

youtube_channel_url

string | null

Required string length: 5 - 500

is_starred

boolean | null

Show child attributes

Response

Successful Response

A competitor entry merged from SEO discoveries and brand-kit names.

Brand-kit-sourced entries lack id, website_url, description, notes, and timestamps — they're synthesized from a string in BrandKit.competitors. The frontend should branch on source to decide which actions to expose (star/edit/delete only work on entries with an id).

source defaults to "seo_discovery" so this schema can also be returned directly from add/update routes that operate on the brand_competitors table — those endpoints always produce SEO rows.

brand_id

string<uuid>

required

name

string

required

string<uuid> | null

seed_id

string<uuid> | null

seed_origin

enum<string> | null

Available options:

public,

private

is_seed

boolean | null

override

CompetitorOverrideResponse · object | null

The copy's diff over its record's seed, for one competitor (T10 Phase 2).

Additive: None on a competitor the diff does not name (a plain seed row). added also includes adopted historical discoveries; it does not prove a manual user action. The UI attributes additions only from explicit analysis_data.added_manually provenance. Removed seeds expose the same diff separately from the active roster, with removed set to True.

Show child attributes

advertiser_id

string<uuid> | null

advertiser_resolved_at

string<date-time> | null

identity_resolved

boolean

default:false

canonical_domain

string | null

website_url

string | null

homepage_url

string | null

website_header_image_url

string | null

description

string | null

notes

string | null

industry

string | null

brand_classification

BrandClassification · object | null

A versioned multi-label brand classification.

Industries describe what the brand sells or does. Business models describe how it operates independently of industry. Keeping those dimensions separate prevents the historical E-Commerce pseudo-industry from replacing the brand's real product industry.

Show child attributes

country

string | null

content_url

string | null

youtube_channel_url

string | null

is_starred

boolean

default:false

analysis_data

Analysis Data · object

brand_intelligence_advertiser_id

string<uuid> | null

active_paid_media_platforms

string[]

created_at

string<date-time> | null

updated_at

string<date-time> | null

source

enum<string>

default:seo_discovery

Available options:

seo_discovery,

brand_kit

Overview

Endpoints

Authorizations

Path Parameters

Body

Response