Skip to main content
POST
Add or update a replacement rule

Authorizations

Authorization
string
header
required

Your Vook API key (mint one from the web app).

Body

application/json
language
enum<string>
required

Language of the dictionary to add to

Available options:
en,
fr
Example:

"en"

source_word
string
required

The word as it gets transcribed, which you want rewritten

Required string length: 1 - 255
Example:

"tumbler"

destination_word
string
required

The word your transcriptions show instead

Required string length: 1 - 255
Example:

"Tumblr"

Response

The replacement rule, new or updated

id
string
required

Replacement rule ID

Example:

"123e4567-e89b-12d3-a456-426614174000"

language
string
required

Language of the dictionary holding the rule

Example:

"en"

source_word
string
required

The word as it gets transcribed

Example:

"tumbler"

destination_word
string
required

The word your transcriptions show instead

Example:

"Tumblr"

created_at
string<date-time>
required

When the rule was created

Example:

"2024-01-15T10:30:00.000Z"