Delete a synonym

Deletes a synonym by its ID.

DELETE /1/indexes/{indexName}/synonyms/{objectID}

curl

cURL

curl --request DELETE \
  --url 'https://algolia_application_id.algolia.net/1/indexes/ALGOLIA_INDEX_NAME/synonyms/synonymID?forwardToReplicas=true' \
  --header 'accept: application/json' \
  --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
  --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID'

200

{
  "deletedAt": "2023-06-27T14:42:38.831Z",
  "taskID": 1514562690001
}

To find the object IDs of your synonyms, use the search operation.

Required ACL: editSettings

Authorizations

x-algolia-application-id · string · header · required

Your Algolia application ID.

x-algolia-api-key · string · header · required

Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint's reference.

Path Parameters

indexName · string · required

Name of the index on which to perform the operation.

Example:

"ALGOLIA_INDEX_NAME"

objectID · string · required

Unique identifier of a synonym object.

Example:

"synonymID"

Query Parameters

forwardToReplicas · boolean

Whether changes are applied to replica indices.

Response

200

application/json

OK

Response, taskID, and deletion timestamp.

deletedAt · string · required

Date and time when the object was deleted, in RFC 3339 format.

Example:

"2023-06-27T14:42:38.831Z"

taskID · integer<int64> · required

Unique identifier of a task.

A successful API response means that a task was added to a queue. It might not run immediately. You can check the task's progress with the task operation and this task ID.

Example:

1514562690001