Skip to main content
POST
/
projects
/
{project_id}
/
jobs
cURL
curl "https://api.phrase.com/v2/projects/:project_id/jobs" \
  -u USERNAME_OR_ACCESS_TOKEN \
  -X POST \
  -d '{"branch":"my-feature-branch","name":"de","briefing":"de-DE","due_date":"2017-08-15","ticket_url":"https://example.atlassian.net/browse/FOO","tags":["myUploadTag"],"translation_key_ids":["abcd1234cdef1234abcd1234cdef1234"]}' \
  -H 'Content-Type: application/json'
{
  "id": "626ea67628690c73ac86ac81eec2d185",
  "name": "Translations for new Feature",
  "briefing": "Some instructions for the translators",
  "due_date": "2017-02-28T09:52:53Z",
  "state": "completed",
  "ticket_url": "https://example.atlassian.net/browse/FOO",
  "created_at": "2017-01-28T09:52:53Z",
  "updated_at": "2017-01-28T09:52:53Z",
  "project": {
    "id": "abcd1234cdef1234abcd1234cdef1234",
    "name": "My Android Project",
    "main_format": "xml",
    "created_at": "2015-01-28T09:52:53Z",
    "updated_at": "2015-01-28T09:52:53Z"
  },
  "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"
    }
  ]
}

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
​
name
string
required

Job name

Example:

"de"

​
branch
string

specify the branch to use

Example:

"my-feature-branch"

​
source_locale_id
string

The API id of the source language

Example:

"abcd1234cdef1234abcd1234cdef1234"

​
briefing
string

Briefing for the translators

Example:

"de-DE"

​
due_date
string<date-time> | null

Date the job should be finished

Example:

"2017-08-15"

​
ticket_url
string

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

Example:

"https://example.atlassian.net/browse/FOO"

​
tags
string[]

tags of keys that should be included within the job

Example:
["myUploadTag"]
​
translation_key_ids
string[]

ids of keys that should be included within the job

Example:
["abcd1234cdef1234abcd1234cdef1234"]
​
job_template_id
string

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

Example:

"abcd1234cdef1234abcd1234cdef1234"

Response

Created

​
id
string
​
name
string
​
briefing
string
​
due_date
string<date-time> | null
​
state
string
​
ticket_url
string
​
project
object
Example:
{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "name": "My Android Project",
  "main_format": "xml",
  "created_at": "2015-01-28T09:52:53Z",
  "updated_at": "2015-01-28T09:52:53Z"
}
​
branch
object
Example:
{ "name": "new-branch" }
​
created_at
string<date-time>
​
updated_at
string<date-time>
​
owner
object
Example:

null

​
job_tag_name
string
​
source_translations_updated_at
string<date-time>
​
source_locale
object
Example:
{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "name": "English",
  "code": "en-GB"
}
​
locales
locale_preview · object[]
​
keys
key_preview · object[]
​
annotations
job_annotation · object[]