Update a dictionary

PATCH /dictionaries/{id}

Update a dictionary

cURL

curl --request PATCH \
  --url https://api.pineyard.ai/dictionaries/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "terms": [
    "<string>"
  ]
}
'

200

{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "terms": [
    "<string>"
  ],
  "charCount": 123,
  "externalId": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Required scope: dictionaries.edit

Authorizations

Authorization · string · header · required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Path Parameters

id · string · required

Body

application/json

name · string

Required string length: 1 - 100

description · string

Maximum string length: 500

terms · string[]

Maximum array length: 2000

Required string length: 1 - 200

Response

200

application/json

OK

id · string · required

name · string · required

description · string | null · required

terms · string[] · required

charCount · number · required

externalId · string | null · required

createdAt · string · required

updatedAt · string · required