Skip to main content
This page documents an earlier version of the API client. For the latest version, see Add or delete dictionary entries.
Required ACL: editSettings

Examples

AlgoliaDictionary algoliaDictionary = new AlgoliaDictionary
{
  Name = AlgoliaDictionaryType.Stopwords
};

// Synchronous
dictionaryClient.ClearDictionaryEntries(algoliaDictionary);

// Asynchronous
var clearDictionaryResponse = dictionaryClient.ClearDictionaryEntriesAsync(algoliaDictionary);
clearDictionaryResponse.Wait();

Parameters

dictionary
string
required
Dictionary type. One of: stopword, plural, compound.
requestOptions
object
A mapping of request options to send along with the request.

Response

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

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
{
  "updatedAt":"2013-01-18T15:33:13.556Z",
  "taskID": 678
}
I