Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-26316155742.7 KB
Job Locales

Add a target locale to a job

Adds a target locale to a job.

post/projects/{project_id}/jobs/{job_id}/locales

Path parameters

project_idstring required

Project ID

job_idstring required

Job ID

Headers

X-PhraseApp-OTPstring

Two-Factor-Authentication token (optional)

Request body

branchstring

specify the branch to use

locale_idstring required

ID of a locale to be added

user_idsstring[]

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

reviewer_idsstring[]

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

translator_team_idsstring[]

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

reviewer_team_idsstring[]

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

Example request

{
  "branch": "my-feature-branch",
  "locale_id": "abcd1234cdef1234abcd1234cdef1234",
  "user_ids": [
    "abcd1234cdef1234abcd1234cdef1234"
  ],
  "reviewer_ids": [
    "abcd1234cdef1234abcd1234cdef1234"
  ],
  "translator_team_ids": [
    "abcd1234cdef1234abcd1234cdef1234"
  ],
  "reviewer_team_ids": [
    "abcd1234cdef1234abcd1234cdef1234"
  ]
}

Response

Created

idstring
completedboolean
translation_completed_atstring date-time
review_completed_atstring date-time

Example response

{
  "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"
}