Skip to Content
HallolaraDocs
Public APIPronunciation

Update a pronunciation item

PATCH
/pronunciation/{pronunciation_id}

Partial update - only included fields are changed. group_id cannot be changed via this endpoint; create a new pronunciation item in the target group instead.

Authorization

bearerAuth
headerAuthorizationBearer <token>

API key in the Authorization: Bearer <key> header. Keys are created in the Hallolara dashboard (Settings → API Keys).

Path Parameters

pronunciation_id*string
Match^[a-f0-9]{24}$

Request Body

application/json
  1. body

Partial update - include only the fields you want to change. group_id cannot be changed via this endpoint. The final merged state must not combine spell_out: true with a non-empty replacement or ipa. An update that sets replacement or ipa must leave only one of them non-empty (send "" to clear the other); entries saved with both before 2026-10-09 keep working and accept updates that set neither. It must retain at least one effective option: nonblank replacement, valid nonblank IPA, spell_out enabled, or an explicit supported rate. Clearing the last effective option is rejected, including for inactive entries. Entries whose stored word is empty or contains whitespace or angle brackets are not returned by GET (by ID they return 404) but can still be deleted, or updated by a PATCH that sets a valid word. Other existing invalid entries remain readable and deletable but must be corrected before saving. Concurrent changes to the validated fields return 409; reload before retrying.

Properties1 <= properties
word?string

The written single-token form to match. Whitespace and angle brackets (<, >) are rejected.

Match^[^\s<>]+$
Length1 <= length <= 200
replacement?string

Angle brackets (<, >) are rejected. Must be empty when the final spell_out state is true. When set, the final ipa must be empty.

Match^(?!\s+$)
Lengthlength <= 1000
ipa?string

International Phonetic Alphabet transcription in the same raw format as on create (no /…/ or […] delimiters, no uppercase letters). Applied on v2 voices; ignored on v1 voices. Must be empty when the final spell_out state is true. When set, the final replacement must be empty.

Match^(?!\s+$)
Lengthlength <= 200
spell_out?boolean

When true, the matched word is spoken letter by letter - API is spoken as A, P, I.

rate?|

Speaking rate stored with the rule; send null to clear it. Currently not applied when the word is spoken, on any voice - the word is spoken at the voice/request speed.

Value innull"slow""medium""fast"
case_sensitive?boolean
active?boolean

Response Body

Updated pronunciation item.

application/json
  1. response
data?
Example Request
curl -X PATCH 'https://api.hallolara.ai/api/v1/pronunciation/65f8fa6f1a9d8e0012ab34cd' \  -H 'Content-Type: application/json' \  -d '{  "case_sensitive": true}'
Example Response
{  "data": {    "id": "string",    "group_id": "string",    "group_name": "string",    "word": "string",    "replacement": "string",    "ipa": "string",    "spell_out": false,    "rate": null,    "case_sensitive": false,    "active": true,    "created_at": "2019-08-24T14:15:22Z",    "updated_at": "2019-08-24T14:15:22Z"  }}