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 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"

owner_id
string

Code of the account member to set as the job template owner. The referenced user must also be a member of the project; passing the code of an account member who is not a project member returns a 404. When omitted or blank, no owner is pre-set; the user who creates a job from this template is assigned as owner at job-creation time.

Response

Created

id
string
name
string
briefing
string
project
project_short · object
Example:
branch
any
autotranslate_enabled
boolean

When true, jobs created from this template are auto-translated on creation.

created_at
string<date-time>
updated_at
string<date-time>
owner
user_preview · object
Example:
creator
user_preview · object
Example:
locales
locale_preview · object[]