Actions

One page per action for the Custom Dictionary API.

Pick an action:

Action

Create a dictionary

Docs

Create dictionary (create)

Action

Delete dictionaries

Docs

Delete dictionary (delete)

Action

Add or replace words

Docs

Add list of words (addwords)

Action

Remove words

Docs

Remove words (deletewords)

Action

Fetch a dictionary wordlist

Docs

Get words from dictionary (getwords)

Action

List dictionaries (metadata)

Docs

List dictionaries (getdicts)

Action

Rename or enable/disable

Docs

Edit dictionary metadata (edit)

Authorization

An access key is required for this command. See Access key.

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

• Response format

• Errors reference