# Create or update a synonym set

**PUT /_synonyms/{id}**

Synonyms sets are limited to a maximum of 10,000 synonym rules per set.

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.

For practical examples of how to create or update a synonyms set, refer to the External documentation.

## Required authorization

* Cluster privileges: `manage_search_synonyms`


[About synonym API examples](https://www.elastic.co/docs/solutions/search/full-text/create-update-synonyms-api-example)

## Servers
- http://api.example.com: http://api.example.com ()


## Authentication methods
- Api key auth
- Basic auth
- Bearer auth


## Parameters

### Path parameters
- **id** (string)
  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

### Body: application/json (object)

- **synonyms_set** (object | array[object])
  The synonym rules definitions for the synonyms set.


## Responses
### 200


#### Body: application/json (object)
- **result** (string)
  The update operation result.
- **reload_analyzers_details** (object)
  Updating a synonyms set can reload the associated analyzers in case refresh is set to true.
  This information is the analyzers reloading result.


[Powered by Bump.sh](https://bump.sh)