Skip to main content
PATCH
/
projects
/
{project_id}
/
job_templates
/
{id}
cURL
curl "https://api.phrase.com/v2/projects/:project_id/job_templates/:id" \
  -u USERNAME_OR_ACCESS_TOKEN \
  -X PATCH \
  -d '{"branch":"my-feature-branch","name":"template","briefing":"text"}' \
  -H 'Content-Type: application/json'
{
  "id": "626ea67628690c73ac86ac81eec2d185",
  "name": "template",
  "briefing": "text",
  "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"
  },
  "creator": {
    "id": "abcd1234cdef1234abcd1234cdef1234",
    "username": "joe.doe",
    "name": "Joe Doe"
  },
  "locales": [
    {
      "id": "abcd1234cdef1234abcd1234cdef1234",
      "name": "English",
      "code": "en-GB"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://developers.phrase.com/llms.txt

Use this file to discover all available pages before exploring further.

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

​
id
string
required

ID

Body

application/json
​
name
string
required

Job template name

Example:

"template"

​
branch
string

specify the branch to use

Example:

"my-feature-branch"

​
briefing
string

Briefing for the translators

Example:

"text"

​
autotranslate
boolean

Automatically translate the job using machine translation.

Example:

true

​
source_locale_id
string

The API id of the source language. This locale will be set as source locale for the job template. If not provided, the project default locale will be used.

Example:

"abcd1234cdef1234abcd1234cdef1234"

Response

OK

​
id
string
​
name
string
​
briefing
string
​
project
project_short · 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
any
​
created_at
string<date-time>
​
updated_at
string<date-time>
​
owner
user_preview · object
Example:
{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "username": "johndoe",
  "name": "John Doe",
  "gravatar_uid": "205e460b479e2e5b48aec07710c08d50"
}
​
creator
user_preview · object
Example:
{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "username": "johndoe",
  "name": "John Doe",
  "gravatar_uid": "205e460b479e2e5b48aec07710c08d50"
}
​
locales
locale_preview · object[]