cURL
curl "https://api.phrase.com/v2/projects/:project_id/jobs/:job_id/locales/:job_locale_id/annotations/:id" \
-u USERNAME_OR_ACCESS_TOKEN \
-X PATCH \
-d '{"value":"Some value..."}' \
-H 'Content-Type: application/json'phrase job_locale_annotations update \
--project_id <project_id> \
--job_id <job_id> \
--job_locale_id <job_locale_id> \
--id <id> \
--data '{"value": "Some value..."}' \
--access_token <token>import requests
url = "https://api.phrase.com/v2/projects/{project_id}/jobs/{job_id}/locales/{job_locale_id}/annotations/{id}"
payload = {
"value": "Some value...",
"branch": "my-feature-branch"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({value: 'Some value...', branch: 'my-feature-branch'})
};
fetch('https://api.phrase.com/v2/projects/{project_id}/jobs/{job_id}/locales/{job_locale_id}/annotations/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.phrase.com/v2/projects/{project_id}/jobs/{job_id}/locales/{job_locale_id}/annotations/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'value' => 'Some value...',
'branch' => 'my-feature-branch'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.phrase.com/v2/projects/{project_id}/jobs/{job_id}/locales/{job_locale_id}/annotations/{id}"
payload := strings.NewReader("{\n \"value\": \"Some value...\",\n \"branch\": \"my-feature-branch\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.phrase.com/v2/projects/{project_id}/jobs/{job_id}/locales/{job_locale_id}/annotations/{id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"value\": \"Some value...\",\n \"branch\": \"my-feature-branch\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.phrase.com/v2/projects/{project_id}/jobs/{job_id}/locales/{job_locale_id}/annotations/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"value\": \"Some value...\",\n \"branch\": \"my-feature-branch\"\n}"
response = http.request(request)
puts response.read_body{
"name": "priority",
"value": "high",
"created_at": "2023-10-01T12:00:00Z",
"updated_at": "2023-10-01T12:00:00Z"
}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}
cURL
curl "https://api.phrase.com/v2/projects/:project_id/jobs/:job_id/locales/:job_locale_id/annotations/:id" \
-u USERNAME_OR_ACCESS_TOKEN \
-X PATCH \
-d '{"value":"Some value..."}' \
-H 'Content-Type: application/json'phrase job_locale_annotations update \
--project_id <project_id> \
--job_id <job_id> \
--job_locale_id <job_locale_id> \
--id <id> \
--data '{"value": "Some value..."}' \
--access_token <token>import requests
url = "https://api.phrase.com/v2/projects/{project_id}/jobs/{job_id}/locales/{job_locale_id}/annotations/{id}"
payload = {
"value": "Some value...",
"branch": "my-feature-branch"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({value: 'Some value...', branch: 'my-feature-branch'})
};
fetch('https://api.phrase.com/v2/projects/{project_id}/jobs/{job_id}/locales/{job_locale_id}/annotations/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.phrase.com/v2/projects/{project_id}/jobs/{job_id}/locales/{job_locale_id}/annotations/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'value' => 'Some value...',
'branch' => 'my-feature-branch'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.phrase.com/v2/projects/{project_id}/jobs/{job_id}/locales/{job_locale_id}/annotations/{id}"
payload := strings.NewReader("{\n \"value\": \"Some value...\",\n \"branch\": \"my-feature-branch\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.phrase.com/v2/projects/{project_id}/jobs/{job_id}/locales/{job_locale_id}/annotations/{id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"value\": \"Some value...\",\n \"branch\": \"my-feature-branch\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.phrase.com/v2/projects/{project_id}/jobs/{job_id}/locales/{job_locale_id}/annotations/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"value\": \"Some value...\",\n \"branch\": \"my-feature-branch\"\n}"
response = http.request(request)
puts response.read_body{
"name": "priority",
"value": "high",
"created_at": "2023-10-01T12:00:00Z",
"updated_at": "2023-10-01T12:00:00Z"
}Authorizations
TokenBasic
Enter your token in the format token TOKEN
Headers
Two-Factor-Authentication token (optional)
Path Parameters
Project ID
Job ID
Job Locale ID
Name of the annotation to set or update.
Body
application/json
Was this page helpful?
⌘I