Parameters reference

Complete parameter list, validation rules, and where each parameter is used.

This API uses cmd=user_dictionary.

Actions are selected via action.

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	Used by	Notes
cmd	string	Yes	all	Always user_dictionary.
action	string	Yes	all	One of: create, delete, rename, check, addword(s), deleteword(s), editword, getdict, setdict.
name	string	Yes	all	Dictionary name to operate on.
new_name	string	Yes	rename	New dictionary name.
word	string	Yes*	addword(s), deleteword(s), editword	Single word. For editword, this is the old word.
new_word	string	Yes	editword	Replacement word value.
wordlist	string	Yes*	create (optional), addword(s), deleteword(s), setdict	Comma-separated words. See precedence rules below.

* Required depends on the action.

word vs wordlist precedence

For addword(s) and deleteword(s):

• If wordlist is present and not empty, it takes precedence.

• Otherwise, word is used.

Validation and limits

Dictionary names (name, new_name)

• Must not be empty.

• Max 50 characters.

• Allowed characters: Latin letters, digits, underscores.

• new_name must differ from name.

Words (word, new_word, wordlist)

• Max 63 characters per word.

• No spaces.

• No punctuation or special characters.