API Reference / API Methods / Synonyms / 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 # A

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

Examples # A

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

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

Parameters # A

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.

requestOptions #
type: key/value mapping
default: No request options
Optional

A mapping of requestOptions to send along with the request.

Response # A

This section shows the JSON response returned by the API. Since each language encapsulates this response inside objects specific to that language and/or implementation, the actual type in your language might differ from what’s written here. You can view the response in the logs (using the getLogs method).

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?
PHP v3