> 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/response-format.md).

# Response format

Successful actions return the same structure.

{% tabs %}
{% tab title="JSON" %}

```json
{
  "name": "my_dict",
  "action": "addword",
  "wordlist": [
    "word1",
    "word2"
  ],
  "modificationTime": 1772124021
}
```

{% endtab %}

{% tab title="XML" %}

```xml
<user_dictionary>
  <name>my_dict</name>
  <action>addword</action>
  <wordlist>
    <word>word1</word>
    <word>word2</word>
  </wordlist>
  <modificationTime>1772124021</modificationTime>
</user_dictionary>
```

{% endtab %}
{% endtabs %}

### Fields

| Field              | Type (JSON) | Notes                                                                                     |
| ------------------ | ----------- | ----------------------------------------------------------------------------------------- |
| `name`             | string      | Dictionary name operated on. After `rename`, this is the **new** name.                    |
| `action`           | string      | Executed action name.                                                                     |
| `wordlist`         | string\[]   | Words affected or returned by the action.                                                 |
| `modificationTime` | integer     | <p>Unix time (seconds).</p><p><code>0</code> can be returned for destructive actions.</p> |