SMAO API Documentation
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
AuthorizationBearer <token>

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

In: header

Path Parameters

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

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. 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

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/pronunciation/65f8fa6f1a9d8e0012ab34cd" \  -H "Content-Type: application/json" \  -d '{    "case_sensitive": true  }'
{  "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"  }}