Skip to main content
POST
/
projects
/
{project_id}
/
jobs
/
{job_id}
/
locales
cURL
curl "https://api.phrase.com/v2/projects/:project_id/jobs/:job_id/locales" \
  -u USERNAME_OR_ACCESS_TOKEN \
  -X POST \
  -d '{"branch":"my-feature-branch","locale_id":"abcd1234cdef1234abcd1234cdef1234","user_ids":["abcd1234cdef1234abcd1234cdef1234"], "translator_team_ids":["abcd1234cdef1234abcd1234cdef1234"]}' \
  -H 'Content-Type: application/json'
{
  "id": "626ea67628690c73ac86ac81eec2d185",
  "job": {
    "id": "abcd1234cdef1234abcd1234cdef1234",
    "name": "My Job 1",
    "state": "completed"
  },
  "users": [
    {
      "id": "abcd1234cdef1234abcd1234cdef1234",
      "username": "joe.doe",
      "name": "Joe Doe",
      "role": "translator"
    }
  ],
  "teams": [
    {
      "id": "abcd1234cdef1234abcd1234cdef1234",
      "name": "Joe's team",
      "role": "translator"
    }
  ],
  "locale": {
    "id": "abcd1234cdef1234abcd1234cdef1234",
    "name": "English",
    "code": "en-GB"
  },
  "annotations": [
    {
      "name": "priority",
      "value": "high",
      "created_at": "2023-10-01T12:00:00Z",
      "updated_at": "2023-10-01T12:00:00Z"
    }
  ],
  "completed": true,
  "translation_completed_at": "2017-01-28T09:52:53Z",
  "review_completed_at": "2017-01-28T09:52:53Z"
}

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

​
job_id
string
required

Job ID

Body

application/json
​
locale_id
string
required

ID of a locale to be added

Example:

"abcd1234cdef1234abcd1234cdef1234"

​
branch
string

specify the branch to use

Example:

"my-feature-branch"

​
user_ids
string[]

Array of user ids to be assigned to the job locale as translators

Example:
["abcd1234cdef1234abcd1234cdef1234"]
​
reviewer_ids
string[]

Array of reviewer ids to be assigned to the job locale as reviewers

Example:
["abcd1234cdef1234abcd1234cdef1234"]
​
translator_team_ids
string[]

Array of team ids to be assigned to the job locale as translators

Example:
["abcd1234cdef1234abcd1234cdef1234"]
​
reviewer_team_ids
string[]

Array of team ids to be assigned to the job locale as reviewers

Example:
["abcd1234cdef1234abcd1234cdef1234"]

Response

Created

​
id
string
​
job
object
Example:

null

​
locale
object
Example:
{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "name": "English",
  "code": "en-GB"
}
​
users
locale_user_preview · object[]
​
teams
locale_team_preview · object[]
​
completed
boolean
​
translation_completed_at
string<date-time>
​
review_completed_at
string<date-time>
​
annotations
job_annotation · object[]