Skip to main content
PUT
/
commerce
/
catalog
/
admin
/
search
/
synonyms
/
{synonymId}
Error
A valid request URL is required to generate request examples
{
  "synonymId": 123,
  "key": "<string>",
  "synonyms": [
    "<string>"
  ]
}

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

​
synonymId
integer<int32>
required

Query Parameters

​
responseFields
string

limits which fields are returned in the response body

Body

application/json
​
synonymId
integer<int32> | null

The unique identifier for the synonym definition

​
key
string | null

If key is defined then map is directed

​
synonyms
string[] | null

List of synonyms. If no key is defined the matches are bidirectional

Response

Success

​
synonymId
integer<int32> | null

The unique identifier for the synonym definition

​
key
string | null

If key is defined then map is directed

​
synonyms
string[] | null

List of synonyms. If no key is defined the matches are bidirectional