> For the complete documentation index, see [llms.txt](https://docs.wproofreader.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.wproofreader.com/api-reference/custom-dictionary-api/actions.md).

# Actions

One page per action for the Custom Dictionary API.

Pick an action:

<table data-view="cards"><thead><tr><th>Action</th><th data-card-target data-type="content-ref">Docs</th></tr></thead><tbody><tr><td>Create a dictionary</td><td><a href="/api-reference/custom-dictionary-api/actions/create-dictionary-create.md">Create dictionary (create)</a></td></tr><tr><td>Delete dictionaries</td><td><a href="/api-reference/custom-dictionary-api/actions/delete-dictionary-delete.md">Delete dictionary (delete)</a></td></tr><tr><td>Add or replace words</td><td><a href="/api-reference/custom-dictionary-api/actions/add-list-of-words-addwords.md">Add list of words (addwords)</a></td></tr><tr><td>Remove words</td><td><a href="/api-reference/custom-dictionary-api/actions/remove-words-deletewords.md">Remove words (deletewords)</a></td></tr><tr><td>Fetch a dictionary wordlist</td><td><a href="/api-reference/custom-dictionary-api/actions/get-words-from-dictionary-getwords.md">Get words from dictionary (getwords)</a></td></tr><tr><td>List dictionaries (metadata)</td><td><a href="/api-reference/custom-dictionary-api/actions/list-dictionaries-getdicts.md">List dictionaries (getdicts)</a></td></tr><tr><td>Rename or enable/disable</td><td><a href="/api-reference/custom-dictionary-api/actions/edit-dictionary-metadata-edit.md">Edit dictionary metadata (edit)</a></td></tr></tbody></table>

{% hint style="info" %}
An **access key** is **required** for this command. See [Access key](/deployment/configuration/application-server/access-key.md).
{% endhint %}

### Common notes

* Requests use `cmd=custom_dictionary` and an `action`.
* Some actions accept multiple IDs (`delete`, `getdicts`).
* Word operations can return `status=warning` for partial success.

Useful references:

* [Parameters reference](/api-reference/custom-dictionary-api/parameters-reference.md)
* [Response format](/api-reference/custom-dictionary-api/response-format.md)
* [Errors reference](/api-reference/custom-dictionary-api/errors-reference.md)
