Update a job - Phrase Developer Hub

curl "https://api.phrase.com/v2/projects/:project_id/jobs/:id" \ -u USERNAME_OR_ACCESS_TOKEN \ -X PATCH \ -d '{"branch":"my-feature-branch","name":"de","briefing":"de-DE","due_date":"2017-08-15","ticket_url":"https://example.atlassian.net/browse/FOO"}' \ -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

string

required

Body

application/json

branch

string

specify the branch to use

Example:

"my-feature-branch"

name

string

Job name

Example:

"de"

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"

target_locale_ids

string[]

List of target locales for the job.

Example:

["abcd1234cdef1234abcd1234cdef1234"]

autotranslate

boolean

Automatically translate the job using machine translation

Example:

true

Response

string

name

string

briefing

string

due_date

string<date-time> | null

state

string

ticket_url

string

project

project_short · object

Show child attributes

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

branch_name · object

Show child attributes

Example:

{ "name": "new-branch" }

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.

owner

user_preview · object

Show child attributes

Example:

{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "username": "johndoe",
  "name": "John Doe",
  "gravatar_uid": "205e460b479e2e5b48aec07710c08d50"
}

job_tag_name

string

source_translations_updated_at

string<date-time>

source_locale

locale_preview · object

Show child attributes

Example:

{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "name": "English",
  "code": "en-GB"
}

locales

locale_preview · object[]

Show child attributes

keys

key_preview · object[]

Show child attributes

annotations

job_annotation · object[]

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

Show child attributes

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