Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-26316155742.7 KB
Jobs

Create a job

Create a new job.

post/projects/{project_id}/jobs

Path parameters

project_idstring required

Project ID

Headers

X-PhraseApp-OTPstring

Two-Factor-Authentication token (optional)

Request body

branchstring

specify the branch to use

namestring required

Job name

source_locale_idstring

The API id of the source language

briefingstring

Briefing for the translators

due_datestring date-time nullable

Date the job should be finished

ticket_urlstring

URL to a ticket for this job (e.g. Jira, Trello)

tagsstring[]

tags of keys that should be included within the job

translation_key_idsstring[]

ids of keys that should be included within the job

target_locale_idsstring[]

List of target locales for the job. Mutually exclusive with job_template_id.

job_template_idstring

id of a job template you would like to model the created job after. Any manually added parameters will take preference over template attributes. Mutually exclusive with target_locale_ids.

autotranslateboolean

Automatically translate the job using machine translation.

Example request

{
  "branch": "my-feature-branch",
  "name": "de",
  "source_locale_id": "abcd1234cdef1234abcd1234cdef1234",
  "briefing": "de-DE",
  "due_date": "2017-08-15",
  "ticket_url": "https://example.atlassian.net/browse/FOO",
  "tags": [
    "myUploadTag"
  ],
  "translation_key_ids": [
    "abcd1234cdef1234abcd1234cdef1234"
  ],
  "target_locale_ids": [
    "abcd1234cdef1234abcd1234cdef1234"
  ],
  "job_template_id": "abcd1234cdef1234abcd1234cdef1234",
  "autotranslate": true
}

Response

Created

idstring
namestring
briefingstring
due_datestring date-time nullable
statestring
ticket_urlstring
created_atstring date-time
updated_atstring date-time
automation_idstring nullable

The ID of the automation that created this job, or null if the job was created manually.

job_template_idstring nullable

The ID of the job template this job was created from, or null if no template was used.

review_due_datestring date-time nullable

The review due date for this job. Returns null when the project does not have review workflow enabled.

job_tag_namestring
source_translations_updated_atstring date-time
lockedboolean

true if the job has been locked by the project's job-locking workflow (translations attached to the job are read-only until the job advances).

Example response

{
  "owner": {
    "id": "abcd1234cdef1234abcd1234cdef1234",
    "username": "joe.doe",
    "name": "Joe Doe"
  },
  "job_tag_name": "Job_123",
  "source_translations_updated_at": "2020-01-01T00:00:00Z",
  "source_locale": {
    "id": "abcd1234cdef1234abcd1234cdef1235",
    "name": "de-DE",
    "code": "de-DE"
  },
  "locales": [
    {
      "id": "abcd1234cdef1234abcd1234cdef1234",
      "name": "English",
      "code": "en-GB"
    }
  ],
  "keys": [
    {
      "id": "dbcd1234cdef1234abcd1234cdef1234",
      "name": "greeting.hello"
    }
  ]
}