SPsponsorunited
EntitySynonym

Add a synonym to a brand, property, league, agency, venue, market, category, subcategory or asset

Saves a name an editor approved in Surface as a synonym of the entity, with source surface and confidence high, so search finds the entity by that name. Brands follow the rules of brand-synonyms/record-match. A synonym belongs to one entity of its type: when another entity has it, nothing is changed and the response is 409 with that entity; this endpoint never moves a synonym, except away from a deleted entity. Service API key only (chat_api).

post/api/entity-synonyms

Request

Request body

entity_type'brand' | 'property' | 'league' | 'agency' | 'venue' | 'market' | 'category' | 'subcategory' | 'asset' required
entity_idinteger required

The id of the entity the synonym names.

synonymstring required

The name the entity is also known by.

Example request

{
  "entity_type": "property",
  "entity_id": 4711,
  "synonym": "Kraken"
}

Response

The entity already had the synonym (already_present), or it was moved away from a deleted entity (moved).

outcomestring

Example response

{
  "outcome": "already_present",
  "data": {
    "id": 7,
    "entity_type": "property",
    "entity_id": 4711,
    "synonym": "Kraken",
    "normalized_synonym": "kraken",
    "source": "surface",
    "confidence": "high"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.