v4

OpenAPI 3.1.02026-07-313621,3961.8 MB

Pronunciation Dictionary

Update Pronunciation Dictionary

Partially update the pronunciation dictionary without changing the version

patch/v1/pronunciation-dictionaries/{pronunciation_dictionary_id}

Path parameters

pronunciation_dictionary_idstring required

The id of the pronunciation dictionary

Example:21m00Tcm4TlvDq8ikWAM

The id of the pronunciation dictionary

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Request body

archivedboolean

Whether to archive the pronunciation dictionary.

namestring

The name of the pronunciation dictionary, used for identification only.

Example request

{
  "archived": true,
  "name": "My Dictionary"
}

Response

Successful Response

idstring required

The ID of the pronunciation dictionary.

latest_version_idstring required

The ID of the latest version of the pronunciation dictionary.

latest_version_rules_numinteger required

The number of rules in the latest version of the pronunciation dictionary.

namestring required

The name of the pronunciation dictionary.

permission_on_resource'admin' | 'editor' | 'commenter' | 'viewer' nullable required

The permission on the resource of the pronunciation dictionary.

created_bystring required

The user ID of the creator of the pronunciation dictionary.

creation_time_unixinteger required

The creation time of the pronunciation dictionary in Unix timestamp.

archived_time_unixinteger nullable

The archive time of the pronunciation dictionary in Unix timestamp.

descriptionstring nullable

The description of the pronunciation dictionary.

Example response

{
  "created_by": "ar6633Es2kUjFXBdR1iVc9ztsXl1",
  "creation_time_unix": 1714156800,
  "description": "This is a test dictionary",
  "id": "5xM3yVvZQKV0EfqQpLrJ",
  "latest_version_id": "5xM3yVvZQKV0EfqQpLr2",
  "latest_version_rules_num": 2,
  "name": "My Dictionary",
  "permission_on_resource": "admin"
}