Replace dictionary content (setdict)

Replace the entire wordlist in a dictionary.

Replace the dictionary content with the provided wordlist.

Parameters

These parameters work with any cmd.

Name	Type	Required	Description
serviceid	string	Cloud only	Cloud API key. Required for Cloud requests. Not used on-premises.
format	string	No	Response format. Values: json (default), xml.
callback	string	No	JSONP wrapper function name. Use only with format=json.
short_answer	boolean	No	JSON only. When true, shortens JSON keys to reduce payload size. See boolean parameters.

See Overview for details.

Command specific parameters

Parameter	Type	Required	Default	Notes
cmd	string	Yes	user_dictionary	Command name.
action	string	Yes	setdict	Action name.
name	string	Yes		Dictionary name.
wordlist	string	Yes		Comma-separated list of words. Must not be empty.

Behavior

• Replaces all existing words.

• Does not support partial updates.

setdict overwrites the full wordlist.

Response

Returns an empty wordlist.

See Response format.

Errors

Common errors:

• Dictionary name is missing, invalid, or longer than 50 characters.

• wordlist is empty.

• A word contains forbidden symbols.

• A word is longer than 63 characters.

See Errors reference.

Examples

Replace a dictionary wordlist

Request body (JSON):

{
  "cmd": "user_dictionary",
  "action": "setdict",
  "name": "my_dict",
  "wordlist": "API,SDK"
}

Response (JSON):

{
  "name": "my_dict",
  "action": "setdict",
  "wordlist": [],
  "modificationTime": 1772124069
}