Sign in

v36

OpenAPI 3.1.0raw.githubusercontent.com2026-08-0187270483.0 KB
Entity Synonyms

Add a Synonym to an Entity

post/v3/entities/{id}/synonyms

Path parameters

idstring required

Entity public ID (ent_...). A merged-away id resolves to the surviving entity.

Query parameters

bucketstring

Optional bucket public ID (bkt_...) to scope the entity lookup to one bucket. Omit for the unscoped (all account+environment) view.

Request body

textstring required

The human-readable synonym surface form to attach (e.g. Acme Corp, ACME). It is normalized (lowercased, whitespace-folded) for the uniqueness key and the matcher's exact-match path.

localestring

Optional BCP 47 locale tag (e.g. en-US) for language-specific synonyms.

Response

The request has succeeded and a new resource has been created as a result.

synonymIDstring required

Stable public identifier for the synonym (esn_...).

textstring required

The human-readable synonym as authored.

normalizedTextstring required

Lowercased, whitespace-folded form of text.

source'extracted' | 'customer_defined' | 'sme_approved' required

Provenance of the synonym. customer_defined and sme_approved synonyms are deletable; extracted synonyms are resolver-owned and cannot be deleted.

localestring

Optional BCP 47 locale tag, when one was supplied.

createdAtstring date-time required

Creation timestamp of the synonym (RFC 3339).