TRtryhamsa

Update Voice Dictionary

Updates an existing voice dictionary.

patch/v1/voice-agents/voice-dictionaries/{id}

Request

  • Base URL
    https://api.tryhamsa.com
  • URL
    https://api.tryhamsa.com/v1/voice-agents/voice-dictionaries/{id}
  • Auth
    API key in header Authorization

Path parameters

idstring uuid required
Example:48f7656f-098b-4c43-b165-7cfd2cc8ac30

UUID of the voice dictionary.

Request body

namestring

Updated name of the voice dictionary.

Example request

{
  "name": "Updated Medical Terms Dictionary",
  "words": [
    {
      "word": "ibuprofen",
      "pronunciation": "eye-byoo-PROH-fen"
    }
  ]
}

Response

Successful response

successboolean
messagestring
messageKeystring

Example response

{
  "success": true,
  "message": "Voice dictionary updated successfully",
  "messageKey": "VoiceDictionaryUpdatedSuccessfully",
  "data": {
    "id": "48f7656f-098b-4c43-b165-7cfd2cc8ac30",
    "name": "Updated Medical Terms Dictionary",
    "updatedAt": "2024-01-15T11:30:00Z"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.