API Reference / API Methods / Synonyms / Delete synonym
Feb. 26, 2019

Delete synonym

Required API Key: any key with the editSettings ACL
Method signature
$index->deleteSynonym(string objectID)

$index->deleteSynonym(string objectID, [
  // All the following parameters are optional
  forwardToReplicas => boolean
])

About this method

Remove a single synonym from an index using its object id.

Examples

1
2
3
4
5
// Delete and forward to replicas

$index->deleteSynonym("a-unique-identifier", [
  'forwardToReplicas' => true
]);

Parameters

objectID
type: string
Required

objectID of the synonym to delete

forwardToReplicas
type: boolean
default: false
optional

Will delete synonym on all replicas. Without this parameter, or by setting it to false, the method still applies the change only to the specified index. If you want to forward the delete to your replicas you will need to set this parameter to true.

Response

In this section we document the JSON response returned by the API. Each language will encapsulate this response inside objects specific to the language and/or the implementation. So the actual type in your language might differ from what is documented.

JSON format

1
2
3
4
{
  "deletedAt":"2013-01-18T15:33:13.556Z",
  "taskID": 678
}
deletedAt
string

Date at which the indexing job has been created.

taskID
integer

The taskID used with the waitTask method.

Did you find this page helpful?