Delete word(s) (deleteword, deletewords)

Remove one word or a wordlist from a user dictionary.

Remove one or more words from 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	deletewords	Use deleteword or deletewords.
name	string	Yes		Dictionary name.
word	string	Yes*		Single word to delete.
wordlist	string	Yes*		Comma-separated list of words. Takes precedence over word.

* Provide word or wordlist.

Behavior

• Deletes the requested word(s).

wordlist precedence

If wordlist is present and not empty, it overrides word.

word / wordlist must not be empty.

Empty values fail at validation time.

Response

Returns the deleted words in wordlist.

See Response format.

Errors

Common errors:

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

• No word was provided, or wordlist is empty.

• Word was not found in the dictionary.

• A word contains forbidden symbols.

• A word is longer than 63 characters.

See Errors reference.

Examples

Delete a single word

Request body (JSON):

{
  "cmd": "user_dictionary",
  "action": "deletewords",
  "name": "my_dict",
  "word": "DevOps"
}

Response (JSON):

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

Delete multiple words

Request body (JSON):

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

Response (JSON):

{
  "name": "my_dict",
  "action": "deleteword",
  "wordlist": ["API", "SDK"],
  "modificationTime": 1772124069
}