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

account_id
string
required

Account ID

Body

application/json
name
string
required

name of the automation

Example:

"Scheduled Job Automation - Hourly"

trigger
enum<string>
required
Available options:
schedule,
upload
project_ids
string[]
required

List of project IDs to associate with the automation. Providing more than one project ID requires the advanced_job_automation plan feature; accounts without this feature receive a 422 response with error field project_ids.

Example:
status_filters
enum<string>[]
required

Translation states used when selecting keys for a job. States are derived from associated translations, not the keys themselves. When review workflow is enabled, ready_for_review is internally treated as translated.

Available options:
unverified,
untranslated,
ready_for_review
job_template_id
string

id of job template that the automation uses to create jobs from

Example:

"abcd1234cdef1234abcd1234cdef1234"

tags
string[]

used to filter which keys are added to jobs

Example:
cron_schedule
string

along with time_zone, specifies when the scheduled automation is supposed to run

Example:

"00 13 * * 1,2"

time_zone
string

along with cron_schedule, specifies when the scheduled automation is supposed to run

Example:

"GMT"

job_owner_id
string

User ID of the job owner that newly created jobs are assigned to.

Example:

"abcd1234abcd1234abcd1234abcd1234"

include_only_updated_locales
boolean

When true, the automation only acts on locales that changed since its last run. Defaults to false.

Example:

false

Response

Created

id
string
name
string
status
enum<string>
Available options:
inactive,
active,
error
trigger
enum<string>
Available options:
schedule,
upload
status_filters
enum<string>[]

translation key statuses used to filter keys that are added to jobs

Available options:
unverified,
untranslated,
ready_for_review
project_id
string
project_ids
string[]

All project IDs the automation applies to. Returned alongside the singular project_id for backwards compatibility.

job_template_id
string
job_owner_id
string | null

User ID of the job owner that newly created jobs are assigned to.

include_only_updated_locales
boolean

When true, the automation only acts on locales that changed since its last run.

tags
string[]
cron_schedule
string
time_zone
string
account
account · object
Example:
created_at
string<date-time>
updated_at
string<date-time>