---
title: "Update a job"
method: PATCH
path: "/projects/{project_id}/jobs/{id}"
tags: ["Jobs"]
---

# Update a job

`PATCH /projects/{project_id}/jobs/{id}`

Update an existing job.

## Path parameters

- `project_id` string, required
- `id` string, required

## Headers

- `X-PhraseApp-OTP` string

## Request body

- object
  - `branch` string — specify the branch to use
  - `name` string — Job name
  - `briefing` string — Briefing for the translators
  - `due_date` string, date-time, nullable — Date the job should be finished
  - `ticket_url` string — URL to a ticket for this job (e.g. Jira, Trello)
  - `target_locale_ids` string[] — List of target locales for the job.
  - `autotranslate` boolean — Automatically translate the job using machine translation

## Response `200`

OK

- JobDetails
  - `id` string
  - `name` string
  - `briefing` string
  - `due_date` string, date-time, nullable
  - `state` string
  - `ticket_url` string
  - `project` ProjectShort
    - `id` string
    - `name` string
    - `main_format` string
    - `created_at` string, date-time
    - `updated_at` string, date-time
  - `branch` object
    - `name` string
  - `created_at` string, date-time
  - `updated_at` string, date-time
  - `automation_id` string, nullable — The ID of the automation that created this job, or null if the job was created manually.
  - `job_template_id` string, nullable — The ID of the job template this job was created from, or null if no template was used.
  - `review_due_date` string, date-time, nullable — The review due date for this job. Returns `null` when the project does not have review workflow enabled.
  - `owner` UserPreview
    - `id` string
    - `username` string
    - `name` string
    - `gravatar_uid` string
  - `job_tag_name` string
  - `source_translations_updated_at` string, date-time
  - `source_locale` LocalePreview
    - `id` string
    - `name` string
    - `code` string
  - `locales` LocalePreview[]
    - `id` string
    - `name` string
    - `code` string
  - `keys` KeyPreview[]
    - `id` string
    - `name` string
    - `plural` boolean
    - `use_ordinal_rules` boolean
  - `annotations` JobAnnotationShort[] — Returned only when `include_annotations=true` is supplied on the request.
    - `name` string, required
    - `value` string, required
  - `locked` boolean — `true` if the job has been locked by the project's job-locking workflow (translations attached to the job are read-only until the job advances).

## Other responses

- `400` — Bad request. The request could not be parsed or a parameter failed validation. Verify the request body, the content type, and the parameter types, then retry.
- `401` — Unauthorized. Authentication failed because the access token is missing, expired, or invalid. Supply a valid access token and retry.
- `403` — Forbidden. The credentials are valid but not permitted for this request: the access token may lack the required scope, the user may lack permission on the resource, or the account plan may not include the feature. Use a token with the required scope on an account and user that hold the necessary permissions.
- `404` — Not found. The requested resource does not exist or is not visible to the authenticated user. Verify the identifiers in the request path and that the token has access to them, then retry.
- `422` — Unprocessable entity. The request was well-formed but failed validation. The response body lists each offending field in the `errors` array, with its resource, field, and a human-readable message. Correct the listed fields and retry.
- `429` — Too many requests. The rate limit has been exceeded. Wait until the time indicated by the `X-Rate-Limit-Reset` response header before retrying.

---

[API](https://skmtc.net/phrase/apis/control-hub-service.md) · [All operations](https://skmtc.net/phrase/apis/control-hub-service/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/phrase/control-hub-service/revisions/98ecac7ba2bf/schema)