Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-26316155742.7 KB
Job Comments

Update a job comment

Update an existing job comment.

patch/projects/{project_id}/jobs/{job_id}/comments/{id}

Path parameters

project_idstring required

Project ID

key_idstring required

Translation Key ID

idstring required

ID

Headers

X-PhraseApp-OTPstring

Two-Factor-Authentication token (optional)

Request body

messagestring

Comment message

branchstring

Branch name for the job

Example request

{
  "message": "Some message...",
  "branch": "my-feature-branch"
}

Response

OK

idstring
messagestring
job_idstring
created_atstring date-time
updated_atstring date-time

Example response

{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "message": "Some message...",
  "job_id": "abcd1234cdef1234abcd1234cdef1234",
  "user": {
    "id": "abcd1234cdef1234abcd1234cdef1234",
    "username": "joe.doe",
    "name": "Joe Doe"
  },
  "created_at": "2015-01-28T09:52:53Z",
  "updated_at": "2015-01-28T09:52:53Z"
}