Skip to main content
POST
cURL

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:
translation_key_ids
string[]

ids of keys that should be included within the job

Example:
target_locale_ids
string[]

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

Example:
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. Mutually exclusive with target_locale_ids.

Example:

"abcd1234cdef1234abcd1234cdef1234"

autotranslate
boolean

Automatically translate the job using machine translation.

Example:

true

Response

Created

id
string
name
string
briefing
string
due_date
string<date-time> | null
state
string
ticket_url
string
project
project_short · object
Example:
branch
branch_name · object
Example:
created_at
string<date-time>
updated_at
string<date-time>
automation_id
string | null

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

job_template_id
string | null

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

review_due_date
string<date-time> | null

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

Example:

"2015-03-25T11:43:52Z"

owner
user_preview · object
Example:
job_tag_name
string
source_translations_updated_at
string<date-time>
source_locale
locale_preview · object
Example:
locales
locale_preview · object[]
keys
key_preview · object[]
annotations
job_annotation · object[]

Returned only when include_annotations=true is supplied on the request.

locked
boolean

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).