Skip to main content
PATCH
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

account_id
string
required

Account ID

id
string
required

ID

Body

application/json
name
string
required

Job template name

Example:

"template"

briefing
string | null

Briefing for the translators. Send an empty string or null to clear the value; omit the field to leave it unchanged. The Phrase CLI drops null values before sending, so use an empty string there.

Example:

"text"

autotranslate
boolean

Automatically translate the job using machine translation.

Example:

true

owner_id
string

Code of the account member to set as the job template owner. Pass an empty string to clear a previously set owner; when blank, the owner is set to null and jobs created from this template will default to assigning the job creator as owner.

Response

OK

id
string
name
string
briefing
string
autotranslate_enabled
boolean

When true, jobs created from this template are auto-translated on creation. Maps to the autotranslate field on the request body.

source_locale_id
string | null

Optional. ID of the source locale used by jobs created from this template. When omitted, the project's default source locale is used.

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