v1

latestOpenAPI 3.0.0Proprietary2026-07-26316155742.7 KB

Jobs

Complete a job

Mark a job as completed.

post/projects/{project_id}/jobs/{id}/complete

Path parameters

project_idstring required

Project ID

idstring required

Headers

X-PhraseApp-OTPstring

Two-Factor-Authentication token (optional)

Request body

branchstring

specify the branch to use

Example request

{
  "branch": "my-feature-branch"
}

Response

idstring

namestring

briefingstring

due_datestring date-time nullable

statestring

ticket_urlstring

created_atstring date-time

updated_atstring date-time

automation_idstring nullable

The ID of the automation that created this job, or null if the job was created manually.

job_template_idstring nullable

The ID of the job template this job was created from, or null if no template was used.

review_due_datestring date-time nullable

The review due date for this job. Returns null when the project does not have review workflow enabled.

job_tag_namestring

source_translations_updated_atstring date-time

lockedboolean

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).

Example response

{
  "owner": {
    "id": "abcd1234cdef1234abcd1234cdef1234",
    "username": "joe.doe",
    "name": "Joe Doe"
  },
  "job_tag_name": "Job_123",
  "source_translations_updated_at": "2020-01-01T00:00:00Z",
  "source_locale": {
    "id": "abcd1234cdef1234abcd1234cdef1235",
    "name": "de-DE",
    "code": "de-DE"
  },
  "locales": [
    {
      "id": "abcd1234cdef1234abcd1234cdef1234",
      "name": "English",
      "code": "en-GB"
    }
  ],
  "keys": [
    {
      "id": "dbcd1234cdef1234abcd1234cdef1234",
      "name": "greeting.hello"
    }
  ]
}