Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-26316155742.7 KB
Translations

Create a translation

Create a translation.

post/projects/{project_id}/translations

Path parameters

project_idstring required

Project ID

Headers

X-PhraseApp-OTPstring

Two-Factor-Authentication token (optional)

Request body

branchstring

specify the branch to use

locale_idstring

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

key_idstring

Key

contentstring

Translation content

plural_suffixstring

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

unverifiedboolean

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

excludedboolean

Indicates whether translation is excluded.

autotranslateboolean

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.

minor_changeboolean

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

reviewedboolean

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

Example request

{
  "branch": "my-feature-branch",
  "locale_id": "abcd1234cdef1234abcd1234cdef1234",
  "key_id": "abcd1234cdef1234abcd1234cdef1234",
  "content": "My translation"
}

Response

Created

idstring
contentstring
unverifiedboolean
excludedboolean
plural_suffixstring
placeholdersstring[]
statestring
created_atstring date-time
updated_atstring date-time
word_countinteger

Example response

{
  "user": {
    "id": "abcd1234cdef1234abcd1234cdef1234",
    "username": "joe.doe",
    "name": "Joe Doe"
  },
  "word_count": 2
}