Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Enter your token in the format token TOKEN

Headers

X-PhraseApp-OTP
string

Two-Factor-Authentication token (optional)

Path Parameters

project_id
string
required

Project ID

Body

application/json
branch
string

specify the branch to use

Example:

"my-feature-branch"

locale_id
string

Locale. Can be the name or id of the locale. Preferred is id

Example:

"abcd1234cdef1234abcd1234cdef1234"

key_id
string

Key

Example:

"abcd1234cdef1234abcd1234cdef1234"

content
string

Translation content

Example:

"My translation"

plural_suffix
string

Plural suffix. Can be one of: zero, one, two, few, many, other. Must be specified if the key associated to the translation is pluralized.

Example:

null

unverified
boolean

Indicates whether translation is unverified. Part of the Advanced Workflows feature.

Example:

null

excluded
boolean

Indicates whether translation is excluded.

Example:

null

autotranslate
boolean

Indicates whether the translation should be auto-translated. Responses with status 422 if provided for translation within a non-default locale or the project does not have the Autopilot feature enabled.

Example:

null

minor_change
boolean

When true, the translation is marked as a minor edit and does not trigger downstream re-verification on the linked locales' translations.

Example:

false

reviewed
boolean

When true and the project's review workflow is enabled, the translation is created in the reviewed state.

Example:

false

Response

Created

id
string
content
string
unverified
boolean
excluded
boolean
plural_suffix
string
key
key_preview · object
Example:

null

locale
locale_preview · object
Example:
placeholders
string[]
state
string
created_at
string<date-time>
updated_at
string<date-time>
linked_translation
translation_parent · object
Example:
user
user_preview · object
Example:
word_count
integer