Skip to main content
POST
/
projects
/
{project_id}
/
translations
cURL
curl "https://api.phrase.com/v2/projects/:project_id/translations" \
  -u USERNAME_OR_ACCESS_TOKEN \
  -X POST \
  -d '{"branch":"my-feature-branch","locale_id":"abcd1234cdef1234abcd1234cdef1234","key_id":"abcd1234cdef1234abcd1234cdef1234","content":"My translation"}' \
  -H 'Content-Type: application/json'
{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "content": "My translation",
  "unverified": false,
  "excluded": false,
  "plural_suffix": "",
  "key": {
    "id": "abcd1234cdef1234abcd1234cdef1234",
    "name": "home.index.headline",
    "plural": false,
    "use_ordinal_rules": false
  },
  "locale": {
    "id": "abcd1234cdef1234abcd1234cdef1234",
    "name": "de",
    "code": "de-DE"
  },
  "placeholders": [
    "%{count}"
  ],
  "state": "translated",
  "created_at": "2015-01-28T09:52:53Z",
  "updated_at": "2015-01-28T09:52:53Z",
  "user": {
    "id": "abcd1234cdef1234abcd1234cdef1234",
    "username": "joe.doe",
    "name": "Joe Doe"
  },
  "word_count": 2
}

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:
{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "name": "English",
  "code": "en-GB"
}
​
placeholders
string[]
​
state
string
​
created_at
string<date-time>
​
updated_at
string<date-time>
​
linked_translation
translation_parent · object
Example:
{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "content": "My parent translation"
}
​
user
user_preview · object
Example:
{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "username": "johndoe",
  "name": "John Doe",
  "gravatar_uid": "205e460b479e2e5b48aec07710c08d50"
}
​
word_count
integer