> For the complete documentation index, see [llms.txt](https://docs.wproofreader.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.wproofreader.com/v6.12.0/api-reference/user-custom-dictionary-api/actions/replace-dictionary-content-setdict.md).

# Replace dictionary content (setdict)

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         | <p>JSON only. When <code>true</code>, shortens JSON keys to reduce payload size.<br>See <a href="/pages/VXTsQ0sY5BFRLUsqxnbL#boolean-parameter-values">boolean parameters</a>.</p> |

See [Overview](/v6.12.0/api-reference/overview.md#common-parameters) 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.

{% hint style="warning" %}
`setdict` overwrites the full wordlist.
{% endhint %}

### Response

Returns an empty `wordlist`.

See [Response format](/v6.12.0/api-reference/user-custom-dictionary-api/response-format.md).

### 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](/v6.12.0/api-reference/user-custom-dictionary-api/errors-reference.md).

### Examples

<details>

<summary>Replace a dictionary wordlist</summary>

**Request body (JSON):**

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

**Response (JSON):**

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

</details>
