v1

latestOpenAPI 3.1.02026-07-241765501.1 MB
Synonym groups

Create synonym group

🔐 This endpoint requires HTTP authentication (either Basic or Bearer). For authenticating with Bearer token, required scopes are: synonyms(w).

Create synonym groups by providing list of the names for the synonyms.

post/v1/synonym_groups

Query parameters

keystring required

The key of the index to use.

Example:key_K2pX7vBnU0bgA5xp
sectionstring

The section of the index to use. Defaults to Products.

Example:Products
cstring

The ID of the client and version that the request is coming from, such as cio-js-2.90.

Example:cio-js-2.90

Request body

synonymsstring[] required

Array of synonyms you want to set

Example request

{
  "synonyms": [
    "tea"
  ]
}

Response

OK

group_idinteger required