> ## Documentation Index
> Fetch the complete documentation index at: https://algolia.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Clear dictionary entries

> Remove all words from a custom dictionary.

export const Legacy = ({title, href}) => {
  return <Note>

    This page documents an earlier version of the API client.
    For the latest version, see <a href={href}>{title}</a>.

    </Note>;
};

<Legacy title="Add or delete dictionary entries" href="/doc/libraries/sdk/methods/search/batch-dictionary-entries" />

**Required ACL:** `editSettings`

## Examples

<CodeGroup>
  ```cs C# theme={"system"}
  AlgoliaDictionary algoliaDictionary = new AlgoliaDictionary
  {
    Name = AlgoliaDictionaryType.Stopwords
  };

  // Synchronous
  dictionaryClient.ClearDictionaryEntries(algoliaDictionary);

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

  ```go Go theme={"system"}
  res, err := client.ClearDictionaryEntries(search.Stopwords)
  ```

  ```java Java theme={"system"}
  // Synchronous
  client.clearDictionaryEntries(Dictionary.STOPWORDS);
  // Asynchronous
  client.clearDictionaryEntriesAsync(Dictionary.STOPWORDS);
  ```

  ```js JavaScript theme={"system"}
  client.clearDictionaryEntries("stopwords");
  ```

  ```kotlin Kotlin theme={"system"}
  client.clearDictionaryEntries(Dictionary.Stopwords)
  // or using extension function:
  client.clearStopwordEntries()
  ```

  ```php PHP theme={"system"}
  $client->clearDictionaryEntries('stopwords');
  ```

  ```python Python theme={"system"}
  client.clear_dictionary_entries("stopwords")
  ```

  ```ruby Ruby theme={"system"}
  client.clear_dictionary_entries("stopwords")
  ```

  ```scala Scala theme={"system"}
  client.execute {
    clear dictionary Stopwords
  }
  ```

  ```swift Swift theme={"system"}
  client.clearDictionaryEntries(in: StopwordsDictionary.self) { result in
    if case .success(let response) = result {
      print("Response: \(response)")
    }
  }
  ```
</CodeGroup>

## Parameters

<ParamField body="dictionary" type="string" required>
  Dictionary type.
  One of: `stopword`, `plural`, `compound`.
</ParamField>

<ParamField body="requestOptions" type="object">
  A mapping of request options to send along with the request.
</ParamField>

## Response

<ResponseField name="taskID" type="integer">
  The task ID used with the [`waitTask`](/doc/libraries/sdk/v1/methods/wait-task) method.
</ResponseField>

<ResponseField name="updatedAt" type="string">
  Date at which the indexing job has been created.
</ResponseField>

### 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.

```jsonc JSON icon=braces theme={"system"}
{
  "updatedAt":"2013-01-18T15:33:13.556Z",
  "taskID": 678
}
```