Change the organization's vocabulary settings. Needs the right to manage the team vocabulary. Send the revision you read as expected_revision; a newer stored revision answers 409. Switching on automatic sharing makes the caller the person whose rights it writes with; saving while it is paused does the same and resumes it.
learn_from_corrections boolean optional
Whether corrections teach private vocabulary.
learned_sharing_mode string optional
approval or automatic.
share_threshold integer optional
Colleagues needed, from 3 to 50.
shared_target_list_id string optional
A list the caller can edit; an explicit null means the organization list.
suggestions_enabled boolean optional
Whether suggestions are collected.
expected_revision integer required
The revision the caller read; a different stored revision answers 409.
The updated vocabulary settings:
learn_from_corrections boolean
Whether a person's corrections teach their own private vocabulary.
learned_sharing_mode string
How words several colleagues taught reach the shared list: approval (an administrator approves each) or automatic.
share_threshold integer
How many colleagues must have taught a word before it is proposed for the shared list.
shared_target_list_id string
The list shared words go to; the organization list unless another list was chosen.
suggestions_enabled boolean
Whether suggestions are collected.
automatic_state string
off in approval mode; active, or paused when automatic sharing stopped by itself.
automatic_paused_reason string or null
Why automatic sharing is paused, when it is.
revision integer
The settings revision; send it back as expected_revision.
editable boolean
Whether the caller may change the settings.
- Bash
- Python
- JavaScript
curl -X PATCH "https://api.aitronos.com/v1/vocabulary/settings" \
-H "X-API-Key: $FREDDY_API_KEY" \
-H "Content-Type: application/json" \
-d '{"share_threshold": 5, "expected_revision": 4}'Response:
{
"learn_from_corrections": true,
"learned_sharing_mode": "approval",
"share_threshold": 5,
"shared_target_list_id": "voclist_1b7d5e9f3a2c4680",
"suggestions_enabled": true,
"automatic_state": "off",
"automatic_paused_reason": null,
"revision": 5,
"editable": true
}- Vocabulary API — Overview of lists, entries and settings.
- Create an access grant — Share a vocabulary list with people, teams or the whole organization.