Rename dictionary (rename)

Rename an existing user dictionary.

Rename a dictionary.

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	rename	Action name.
name	string	Yes		Current dictionary name.
new_name	string	Yes		New dictionary name.

Behavior

• Renames the dictionary.

Response

• name in the response is the new name.

• wordlist is empty.

See Response format.

Errors

Common errors:

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

  • This applies to both name and new_name.

• New name is the same as the current name.

• Target dictionary name already exists.

See Errors reference.

Examples

Rename a dictionary

Request body (JSON):

{
  "cmd": "user_dictionary",
  "action": "rename",
  "name": "my_dict",
  "new_name": "my_dict_v2"
}

Response (JSON):

{
  "name": "my_dict_v2",
  "action": "rename",
  "wordlist": [],
  "modificationTime": 1772124069
}