Parameters reference

Full parameter list, validation rules, and which actions use each parameter.

Requests use the standard HTTP API pattern.

See HTTP API Overview for endpoint details and GET vs POST.

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.

Parameters

Parameter	Type	Used by	Required	Notes
cmd	string	All	Yes	Always custom_dictionary.
action	string	All	Yes	One of: create, delete, addwords, deletewords, getwords, getdicts, edit.
id	integer or comma-separated integers	All except create	Depends	delete and getdicts accept multiple IDs. Other actions require exactly one ID.
lang	string	create	Yes	Language code like en_US.
description	string	create, edit	create: Yes	Must be unique per account.
wordlist	string (comma-separated)	create, addwords, deletewords	Depends	Optional for create. Required for addwords and deletewords.
state	boolean	edit	Optional	true enables. false disables.
overwrite	boolean	addwords	Optional	When true, replaces the entire dictionary wordlist. Default: false. See boolean parameters.

Validation rules

Words (wordlist)

• Max 63 characters per word

• No spaces

• No punctuation or special characters

Words already recognized as correct by the spellcheck engine for the dictionary language are filtered out.

They won’t be stored in the dictionary.

Description (description)

• Required for create.

• Must be unique per account.

• For edit, setting the same description can still conflict.

State (state)

• true: enabled and used in spellcheck.

• false: disabled and excluded from spellcheck.

overwrite

When overwrite=true for addwords, the server replaces the whole dictionary wordlist.

overwrite=true is destructive.

It removes all existing words not present in the request.