Create or update a synonym set Generally available; Added in 8.10.0

PUT /_synonyms/{id}

Synonyms sets are limited to a maximum of 10,000 synonym rules per set. If you need to manage more synonym rules, you can create multiple synonym sets.

When an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices. This is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set. ##Required authorization

  • Cluster privileges: manage_search_synonyms

Path parameters

  • id string Required

    The ID of the synonyms set to be created or updated.

Query parameters

  • refresh boolean

    If true, the request will refresh the analyzers with the new synonyms set and wait for the new synonyms to be available before returning. If false, analyzers will not be reloaded with the new synonym set

application/json

Body Required

  • synonyms_set object | array[object] Required

    The synonym rules definitions for the synonyms set.

    One of:
    SynonymRule object array-2 array[object]
    Hide attributes Show attributes object
    • id string
    • synonyms string Required

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • result string Required

      Values are created, updated, deleted, not_found, or noop.

    • reload_analyzers_details object
      Hide reload_analyzers_details attributes Show reload_analyzers_details attributes object
      • reload_details array[object] Required
        Hide reload_details attributes Show reload_details attributes object
        • index string Required
        • reloaded_analyzers array[string] Required
        • reloaded_node_ids array[string] Required
      • _shards object Required
        Hide _shards attributes Show _shards attributes object
        • failed number Required
        • successful number Required
        • total number Required
        • failures array[object]
          Hide failures attributes Show failures attributes object
          • index string
          • node string
          • reason object Required
            Hide reason attributes Show reason attributes object
            • type string Required

              The type of error

            • reason
            • stack_trace string

              The server stack trace. Present only if the error_trace=true parameter was sent with the request.

            • caused_by object
            • root_cause array[object]
            • suppressed array[object]
          • shard number Required
          • status string
        • skipped number
PUT /_synonyms/{id} 
PUT _synonyms/my-synonyms-set

curl \
 --request PUT 'http://api.example.com/_synonyms/{id}' \
 --header "Content-Type: application/json" \
 --data '"{\n  \"synonyms_set\": [\n    {\n      \"id\": \"test-1\",\n      \"synonyms\": \"hello, hi\"\n    },\n    {\n      \"synonyms\": \"bye, goodbye\"\n    },\n    {\n      \"id\": \"test-2\",\n      \"synonyms\": \"test =\u003e check\"\n    }\n  ]\n}"'
Request example
An example body for a `PUT _synonyms/my-synonyms-set` request. 
{
  "synonyms_set": [
    {
      "id": "test-1",
      "synonyms": "hello, hi"
    },
    {
      "synonyms": "bye, goodbye"
    },
    {
      "id": "test-2",
      "synonyms": "test => check"
    }
  ]
}

Documentation preview

This is a preview of your version @2025-06-09 which is not yet released.

View current documentation