Skip to content

Update a vocabulary list

Change a list's name, description, enabled switch or team space. Send only the fields to change. Needs edit rights on the list; a list the caller can read but not edit answers 403.

PATCHhttps://api.aitronos.com/v1/vocabulary/lists/{list_id}

Path Parameters

list_id string required

The list ID.

Request Body

name string optional

The new name, 1 to 200 characters.

description string optional

The new description; null clears it.

enabled boolean optional

Whether the list's words are used in transcripts.

team_space_id string optional

Move the list into a team space; an explicit null takes it out.


Returns

The updated vocabulary list:

id string

The list ID.

kind string

organization for the one list every organization has; custom otherwise.

name string

The list name.

description string or null

An optional description.

team_space_id string or null

The team space the list belongs to, if any.

owner_user_id string or null

The person who owns the list; null for the organization list.

enabled boolean

Whether the list's words are used in transcripts.

entry_count integer

Live entries in the list the caller can read.

reached_through string

How the list reached the caller: owner, person, role, department, team, team_space, organization or admin (only through administration rights).

can_edit boolean

Whether the caller may change the list.

can_share boolean

Whether the caller may share the list.

can_delete boolean

Whether the caller may delete the list.

created_at string

When the list was created.

updated_at string

When the list last changed.

cURL
curl -X PATCH "https://api.aitronos.com/v1/vocabulary/lists/voclist_8f2a61c4e0b94d7a" \
  -H "X-API-Key: $FREDDY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Product and feature names"}'

Response:

200 OK
{
  "id": "voclist_8f2a61c4e0b94d7a",
  "kind": "custom",
  "name": "Product and feature names",
  "description": "Names of our products and features.",
  "team_space_id": null,
  "owner_user_id": "usr_3c91d0a2b7e4",
  "enabled": true,
  "entry_count": 12,
  "reached_through": "owner",
  "can_edit": true,
  "can_share": true,
  "can_delete": true,
  "created_at": "2026-10-24T09:30:00Z",
  "updated_at": "2026-10-24T09:30:00Z"
}