> 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/custom-dictionary-api/actions/edit-dictionary-metadata-edit.md).

# Edit dictionary metadata (edit)

Updates a dictionary description or its enabled state.

### What it does

* Renames a dictionary (`description`).
* Enables or disables a dictionary (`state`).

### Required parameters

| Parameter | Type    | Notes                     |
| --------- | ------- | ------------------------- |
| `cmd`     | string  | `custom_dictionary`       |
| `action`  | string  | `edit`                    |
| `id`      | integer | Exactly one dictionary ID |

### Optional parameters

You must pass at least one of these.

| Parameter     | Type    | Notes                            |
| ------------- | ------- | -------------------------------- |
| `description` | string  | Must be unique per account       |
| `state`       | boolean | `true` enables, `false` disables |
| `format`      | string  | `json` (default) or `xml`        |
| `callback`    | string  | JSONP wrapper (JSON only)        |

{% hint style="info" %}
If you disable a dictionary (`state=false`), spellcheck excludes it silently.

The dictionary is still accessible via the API.
{% endhint %}

### Request example (rename)

```
cmd=custom_dictionary&action=edit&id=101565&description=Engineering and product terms
```

### Request example (disable)

```
cmd=custom_dictionary&action=edit&id=101565&state=false
```

### Response example

```json
{
  "result": [
    {
      "id": 101565,
      "description": "Engineering and product terms",
      "state": false,
      "status": "success",
      "message": ["Dictionary updated."]
    }
  ]
}
```

### Possible errors

* Missing `id`.
* Multiple IDs passed (only one is allowed).
* Neither `description` nor `state` passed.
* Description conflicts with an existing dictionary.

See [Errors reference](/v6.12.0/api-reference/custom-dictionary-api/errors-reference.md).

### Notes and edge cases

* Disabling is a safe alternative to delete.
* Description uniqueness is enforced per account.