Edit a word group
update_groupDestructiveIdempotent
Renames a word group or changes its description; null clears the description. Requires the group's latest version. Sharing settings and the group image are preserved. requestId makes retries idempotent.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | ||
| groupId | Yes | ||
| requestId | Yes | ||
| description | No | ||
| languageCode | Yes | Code of the learning language, for example en-GB or es-ES. | |
| expectedVersion | Yes | Opaque revision token from the latest read or save of this item. A stale token returns WORD_CHANGED or GROUP_CHANGED without saving. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | ||
| status | No | ||
| groupId | No | ||
| version | No | ||
| wordsDeleted | No |