Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-26316155742.7 KB
Job Annotations

Create/Update a job locale annotation

Create or update an annotation for a job locale. If the annotation already exists, it will be updated; otherwise, a new annotation will be created.

patch/projects/{project_id}/jobs/{job_id}/locales/{job_locale_id}/annotations/{id}

Path parameters

project_idstring required

Project ID

job_idstring required

Job ID

job_locale_idstring required

Job Locale ID

idstring required

Name of the annotation to set or update.

Headers

X-PhraseApp-OTPstring

Two-Factor-Authentication token (optional)

Request body

valuestring

Annotation value

branchstring

Branch name of the job

Example request

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

Response

OK

namestring required
valuestring required
created_atstring date-time
updated_atstring date-time

Example response

{
  "name": "priority",
  "value": "high",
  "created_at": "2023-10-01T12:00:00Z",
  "updated_at": "2023-10-01T12:00:00Z"
}