Lexicons

Update a Lexicon Entry

Updates a Lexicon entry.

patch/v2.0/lexicons/{lexiconId}/entries/{entryId}

Request

Base URL
https://api-trial.cognigy.ai/testing
Auth
- API key in header X-API-Key
- or API key in query parameter api_key
- or API key in header x-cxone-authorization
- or OAuth 2
  Authorization code/auth/oauth2/authorize
  Password
  Token URL/auth/oauth2/token
TypeScript
https://skmtc.dev/cognigy/apis/simulator-openapi-rest-ful-api-reference/docs/v2.0/lexicons/:lexiconId/entries/:entryId/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

lexiconIdstring required

The unique identifier for the Lexicon.

entryIdstring required

The unique identifier for the entry in the Lexicon.

Headers

Accept'application/json' | 'application/hal+json' | 'application/xml' | 'text/xml' | 'text/csv'

The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.

Request body

datastring

Additional JSON-data of the lexicon entry

slotReferencesstring[]

The used slots by the lexicon entry

mainKeyphrasestring required

the keyphrase value

Example request

{
  "data": "{\"key1\": \"value1\" }",
  "mainKeyphrase": "pizza"
}

Response

Successfully updated Entry.

Changes

No recorded changes to this operation across all 1 revision of this API.