Delete dictionary entries

Required API Key: any key with the editSettings ACL

Method signature
client.delete_dictionary_entries(
  string dictionary,
  array  objectIDs,
  # + any requestOptions
)

About this method # A

Delete a batch of dictionary entries.

Examples # A

Delete stopword entries#

1
2
3
4
client.delete_dictionary_entries(
  'stopwords',
  ['down', 'up']
)

Parameters # A

dictionary #
type: string
Required

Type of the dictionary entries you want to delete. Can be either stopword, plural or compound

objectIDs #
type: array
Optional

Dictionary entry objectIDs.

objectID isn’t a reference to an Algolia record: it’s the unique identifier for a dictionary object.

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

A mapping of request options to send along with the request.

Response # A

This section shows the JSON response returned by the API. Each API client encapsulates this response inside objects specific to the programming language, so that the actual response might be different. You can view the response by using the getLogs method. Don’t rely on the order of attributes in the response, as JSON doesn’t guarantee the ordering of keys in objects.

JSON format#

1
2
3
4
{
  "updatedAt":"2013-01-18T15:33:13.556Z",
  "taskID": 678
}
Field Description
updatedAt #
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?