Skip to Content

Topics

Topics are your organisation’s catalogue of subjects. VOIX tags each analysed call with the topics that apply to it. Reading and changing topics needs a Full access key; changing them also needs an organisation key.

List topics

GET https://api.voix.tech/public/v1/topics
{ "data": [ { "id": "7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d", "name": "Payment plan", "hint": "Payment in instalments or a deferral is agreed or discussed.", "color": "#16a34a", "active": true, "createdAt": "2026-10-13T08:00:00.000Z", "updatedAt": "2026-10-13T08:00:00.000Z" } ] }

Create a topic

POST https://api.voix.tech/public/v1/topics
FieldTypeRequiredDescription
namestringYesUp to 80 characters, unique in the organisation.
colorstringYesHex color, e.g. #2563eb.
hintstringNoUp to 500 characters. Tells the analysis when the topic applies.
activebooleanNoDefault true. Inactive topics are not assigned to new calls.
curl -X POST https://api.voix.tech/public/v1/topics \ -H "Authorization: Bearer vx_your_api_key" \ -H "Content-Type: application/json" \ -d '{ "name": "Payment plan", "color": "#16a34a", "hint": "Payment in instalments or a deferral is agreed or discussed." }'

Returns 201 with the topic. New topics apply to calls analysed from then on.

Update a topic

PATCH https://api.voix.tech/public/v1/topics/{id}

Send any of name, color, hint or active. Returns the updated topic.

Delete a topic

DELETE https://api.voix.tech/public/v1/topics/{id}

Returns 204. The topic is removed from the calls it was assigned to. To keep it on past calls, set active to false instead.

Last updated on