Update synonym map (Azure AI Search REST API)
Important
This API reference is for a legacy version. See Data plane REST operations for updated reference documentation. Use the filter on the top left to select a version.
Overwrites an existing synonym map definition with a revised version.
PUT https://[service name].search.windows.net/synonymmaps/[synonymmap name]?api-version=[api-version]
Content-Type: application/json
api-key: [admin key]
URI Parameters
| Parameter | Description |
|---|---|
| service name | Required. Set this to the unique, user-defined name of your search service. |
| synonym map name | Required. The request URI specifies the name of the synonym map to update. |
| api-version | Required. The current stable version is api-version=2020-06-30. See API versions for more versions. |
Request Headers
The following table describes the required and optional request headers.
| Fields | Description |
|---|---|
| Content-Type | Required. Set this to application/json |
| api-key | Optional if you're using Azure roles and a bearer token is provided on the request, otherwise a key is required. An api-key is a unique, system-generated string that authenticates the request to your search service. Update requests must include an api-key header set to your admin key (as opposed to a query key). See Connect to Azure AI Search using key authentication for details. |
Request Body
The request body syntax is the same as for Create Synonym Map.
When updating an existing synonym map, the entire definition is replaced with the contents of the request body. In general, the best pattern to use for updates is to retrieve the definition with a GET, modify it, and then update it with PUT.
Response
For a successful request, "201 Created" if a new synonym map was created, and "204 No Content" if an existing synonym map was updated
By default the response body will be empty. However, if the Prefer request header is set to return=representation, the response body will contain the JSON for the synonym map that was updated or created. In this case, the success status code will be "201 Created" if a new synonym map was created and "200 OK" if an existing synonym map was updated.