Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-26316155742.7 KB
Automations

Update an automation

Update an existing automation.

For feature availability, see Jobs (Strings).

patch/accounts/{account_id}/automations/{automation_id}

Path parameters

account_idstring required

Account ID

idstring required

ID

Headers

X-PhraseApp-OTPstring

Two-Factor-Authentication token (optional)

Request body

namestring required

name of the automation

trigger'schedule' | 'upload' required
project_idsstring[] 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.

job_template_idstring

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

status_filtersstring[] required

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

tagsstring[]

used to filter which keys are added to jobs

cron_schedulestring

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

time_zonestring

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

job_owner_idstring

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

include_only_updated_localesboolean

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

Example request

{
  "name": "Scheduled Job Automation - Hourly",
  "project_ids": [
    "abcd1234cdef1234abcd1234cdef1234"
  ],
  "job_template_id": "abcd1234cdef1234abcd1234cdef1234",
  "tags": [
    "myTag"
  ],
  "cron_schedule": "00 13 * * 1,2",
  "time_zone": "GMT",
  "job_owner_id": "abcd1234abcd1234abcd1234abcd1234"
}

Response

OK

idstring
namestring
status'inactive' | 'active' | 'error'
trigger'schedule' | 'upload'
status_filtersstring[]

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

project_idstring
project_idsstring[]

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

job_template_idstring
job_owner_idstring nullable

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

include_only_updated_localesboolean

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

tagsstring[]
cron_schedulestring
time_zonestring
created_atstring date-time
updated_atstring date-time

Example response

{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "name": "My First Automation",
  "status": "active",
  "trigger": "schedule",
  "status_filters": [
    "unverified",
    "untranslated",
    "ready_for_review"
  ],
  "project_id": "abcd1234cdef1234abcd1234cdef1234",
  "job_template_id": "abcd1234cdef1234abcd1234cdef1234",
  "tags": [
    "tag-1",
    "tag-2"
  ],
  "cron_schedule": "00 13 * * 1,2",
  "time_zone": "GMT",
  "account": "account",
  "created_at": "2021-06-28T09:52:53Z",
  "updated_at": "2021-06-28T09:52:53Z"
}