---
title: "Create brand synonym"
method: POST
path: "/api/brand-synonyms"
tags: ["BrandSynonym"]
---

# Create brand synonym

`POST /api/brand-synonyms`

## Request

- Base URL: `https://api.sponsorunited.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.sponsorunited.com/api/brand-synonyms`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/sponsorunited/apis/sponsorunited-api/docs/api/brand-synonyms/post.ts> (a function with typed inputs; its response is checked against the schema)

Adds a hand-curated synonym to a brand. A synonym belongs to one brand: names that differ only in
     *     case, punctuation or a corporate suffix count as the same synonym. When another brand already has it, the response
     *     is 409 with that brand; send confirm_move=true to move it. Competitors whose name matches the synonym are linked
     *     to the brand, and competitors linked through the moved synonym follow it.

## Request body

- BrandSynonymStoreRequest
  - `brand_id` integer, required
  - `synonym` string, required
  - `confirm_move` boolean: Move the synonym from the brand that owns it now. Without it, a synonym another brand owns returns 409 with that brand.

## Response `200`

The brand already had the synonym from a competitor link or a pipeline; it is now marked as hand-curated.

- object
  - `data` BrandSynonymResource
    - `id` integer
    - `brand_id` integer
    - `synonym` string
    - `normalized_synonym` string, nullable: The synonym normalized for matching; each normalized name belongs to one brand. Empty on rows written before it existed, until the backfill command fills it.
    - `source` 'manual' | 'admin_link' | 'queue_approval' | 'auto_link' | 'edgar' | 'podcast_scouting' | 'logo_detection' | 'surface'
    - `confidence` 'high' | 'medium' | 'low', nullable
    - `matched_at` string, date-time, nullable

## Other responses

- `201`: The new or moved brand synonym.
- `403`: The user may not edit brands.
- `409`: Another brand already has this synonym.
- `422`: The brand already has this synonym by hand, or the name has no letters or digits.

---

[API](https://skmtc.dev/sponsorunited/apis/sponsorunited-api.md) - [All operations](https://skmtc.dev/sponsorunited/apis/sponsorunited-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sponsorunited/apis/sponsorunited-api/revisions/cbf1ca5bff8f?raw)