---
title: "Update brand synonym"
method: PUT
path: "/api/brand-synonyms/{id}"
tags: ["BrandSynonym"]
---

# Update brand synonym

`PUT /api/brand-synonyms/{id}`

## 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/{id}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/sponsorunited/apis/sponsorunited-api/docs/api/brand-synonyms/:id/put.ts> (a function with typed inputs; its response is checked against the schema)

Renames a brand synonym. The renamed synonym is hand-curated. When another brand already has the new
     *     name, the response is 409 with that brand; send confirm_move=true to move it. Competitors are re-linked for both
     *     the old and the new name.

## Path parameters

- `id` string, required

## Request body

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

## Response `200`

The updated brand synonym.

- 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

- `403`: The user may not edit brands.
- `404`: No brand synonym with this id.
- `409`: Another brand already has the new name.
- `422`: 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)