Skip to main content
PATCH
/
dictionaries
/
{id}
Update a dictionary
curl --request PATCH \
  --url https://api.vocobase.com/api/v2/dictionaries/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "terms": [
    "Vocobase",
    "SKU-4471",
    "SKU-4472",
    "Pro Annual Plan"
  ]
}
'
{
  "success": true,
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "term_count": 123,
    "char_count": 123,
    "attached_agent_count": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "terms": [
      "<string>"
    ]
  }
}

Authorizations

​
Authorization
string
header
required

API key in format: rg_live_xxxx. Pass as a Bearer token in the Authorization header.

Path Parameters

​
id
string<uuid>
required

Dictionary ID.

Body

application/json
​
name
string
Required string length: 1 - 100
​
description
string | null
Maximum string length: 500
​
terms
string[]

Response

Dictionary updated.

​
success
boolean
​
data
object