Edit a word
update_wordChanges a word's headword, part of speech, level, topic, pronunciation, hard-to-spell mark and spelling note, usage note, corrected form, collocations, expressions, related words or the user's private note. Only the fields given change; meanings and practice progress are not touched. A headword the notebook already has is refused. The previous values are replaced.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| pos | No | Part of speech; empty clears it. | |
| note | No | The user's own private note on the word; empty clears it. | |
| level | No | CEFR level; empty clears it. | |
| topic | No | The topic the word is filed under; empty files it under general. | |
| word_id | Yes | The id of a word from another tool's result. | |
| headword | No | The corrected word or phrase. | |
| correction | No | The natural, correctly spelled form of the headword; empty clears it. | |
| usage_note | No | A note on register, grammar or common mistakes, in the meaning language; empty clears it. | |
| expressions | No | Replaces the word's expressions; an empty list removes them. | |
| collocations | No | Replaces the word's collocations; an empty list removes them. | |
| hard_spelling | No | Whether the word is marked as hard to spell. | |
| pronunciation | No | IPA or a simple respelling; empty clears it. | |
| related_words | No | Replaces the word's related words; an empty list removes them. | |
| spelling_note | No | What makes the spelling hard, in the meaning language; empty clears it. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| pos | No | ||
| level | No | ||
| topic | No | ||
| addedOn | Yes | ||
| headword | Yes | ||
| meanings | Yes | ||
| progress | Yes | ||
| usageNote | No | ||
| correction | No | ||
| notebookId | Yes | ||
| expressions | No | ||
| collocations | No | ||
| hardSpelling | No | ||
| relatedWords | No | ||
| spellingNote | No | ||
| pronunciation | No | ||
| originalMeaning | No |