Skip to main content
This page documents an earlier version of the API client. For the latest version, see Delete a synonym.
Required ACL: editSettings

​
Examples

index.DeleteSynonym("a-unique-identifier", forwardToReplicas: true);

// Asynchronous
await index.DeleteSynonymAsync("a-unique-identifier", forwardToReplicas: true);

​
Parameters

​
objectID
string
required
Object ID of the synonym to delete.
​
forwardToReplicas
boolean
default:false
Whether to delete the synonym also from all replicas of the index.
​
requestOptions
object
A mapping of request options to send along with the request.

​
Response

​
deletedAt
string
Date at which the indexing job has been created.
​
taskID
integer
The task ID used with the waitTask method.

​
Response as JSON

This section shows the JSON response returned by the API. Each API client wraps this response in language-specific objects, so the structure may vary. To view the response, use the getLogs method. Don’t rely on the order of properties—JSON objects don’t preserve key order.
JSON
{
  "deletedAt":"2013-01-18T15:33:13.556Z",
  "taskID": 678
}
⌘I