Update Synonym Group

Updates a synonym group.

PUT /api/synonymsgroup

Update Synonym Group

cURL

curl --request PUT \
  --url https://api.cludo.com/api/synonymsgroup \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "groupId": 123,
  "words": [
    "<string>"
  ],
  "language": "<string>"
}
'

200

{
  "groupId": 123,
  "words": [
    "<string>"
  ],
  "language": "<string>"
}

Authorizations

Authorization · string · header · required

Basic authentication. Use your Customer ID as the username and API Key as the password. Example header: Authorization: Basic MTIzNDU2NzpteS1hcGkta2V5.

Body

application/json

groupId · integer · required

Existing group to replace.

words · string[] · required

Full new word list for the group.

language · string · required

Language code (must stay consistent unless migrating groups).

Response

200

application/json

Synonym group updated successfully.

groupId · integer · required

Synonym group ID (assigned by server on create).

words · string[] · required

Equivalents treated as the same intent for search (e.g. motorcycle, bike).

language · string · required

A two-letter ISO language code (e.g. en, da, de) this group applies to.