cURL
curl "https://api.phrase.com/v2/projects/:project_id/styleguides/:id" \
-u USERNAME_OR_ACCESS_TOKEN \
-X PATCH \
-d '{"title":"Web application style guide","audience":"customer-facing","target_audience":"teenager","grammatical_person":"first_person_singular","vocabulary_type":"technical","business":"We are a travel site that helps customers find the best hotels and flights.","company_branding":"ACME Inc. should never be translated.","formatting":"Never use capital letters","glossary_terms":"Apartment, cabin, loft","grammar_consistency":","literal_translation":"Neutral","overall_tone":"Tone should be fun and light","samples":"http://www.myexample.com/my/document/path/to/samples.pdf"}' \
-H 'Content-Type: application/json'phrase styleguides update \
--project_id <project_id> \
--id <id> \
--data '{"title": "Web application style guide", "audience":"customer-facing", "target_audience":"teenager", "grammatical_person":"first_person_singular", "vocabulary_type":"technical", "business": "We are a travel site that helps customers find the best hotels and flights.", "company_branding": "ACME Inc. should never be translated.", "formatting": "Never use capital letters", "glossary_terms": "Apartment, cabin, loft", "grammar_consistency":", "literal_translation":"Neutral", "overall_tone": "Tone should be fun and light", "samples": "http://www.myexample.com/my/document/path/to/samples.pdf"}' \
--access_token <token>import requests
url = "https://api.phrase.com/v2/projects/{project_id}/styleguides/{id}"
payload = {
"title": "Web application style guide",
"audience": "customer-facing",
"target_audience": "teenager",
"grammatical_person": "first_person_singular",
"vocabulary_type": "technical",
"business": "We are a travel site that helps customers find the best hotels and flights.",
"company_branding": "ACME Inc. should never be translated.",
"formatting": "Never use capital letters",
"glossary_terms": "Apartment, cabin, loft",
"grammar_consistency": "",
"literal_translation": "Neutral",
"overall_tone": "Tone should be fun and light",
"samples": "http://www.myexample.com/my/document/path/to/samples.pdf"
}
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({
title: 'Web application style guide',
audience: 'customer-facing',
target_audience: 'teenager',
grammatical_person: 'first_person_singular',
vocabulary_type: 'technical',
business: 'We are a travel site that helps customers find the best hotels and flights.',
company_branding: 'ACME Inc. should never be translated.',
formatting: 'Never use capital letters',
glossary_terms: 'Apartment, cabin, loft',
grammar_consistency: '',
literal_translation: 'Neutral',
overall_tone: 'Tone should be fun and light',
samples: 'http://www.myexample.com/my/document/path/to/samples.pdf'
})
};
fetch('https://api.phrase.com/v2/projects/{project_id}/styleguides/{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}/styleguides/{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([
'title' => 'Web application style guide',
'audience' => 'customer-facing',
'target_audience' => 'teenager',
'grammatical_person' => 'first_person_singular',
'vocabulary_type' => 'technical',
'business' => 'We are a travel site that helps customers find the best hotels and flights.',
'company_branding' => 'ACME Inc. should never be translated.',
'formatting' => 'Never use capital letters',
'glossary_terms' => 'Apartment, cabin, loft',
'grammar_consistency' => '',
'literal_translation' => 'Neutral',
'overall_tone' => 'Tone should be fun and light',
'samples' => 'http://www.myexample.com/my/document/path/to/samples.pdf'
]),
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}/styleguides/{id}"
payload := strings.NewReader("{\n \"title\": \"Web application style guide\",\n \"audience\": \"customer-facing\",\n \"target_audience\": \"teenager\",\n \"grammatical_person\": \"first_person_singular\",\n \"vocabulary_type\": \"technical\",\n \"business\": \"We are a travel site that helps customers find the best hotels and flights.\",\n \"company_branding\": \"ACME Inc. should never be translated.\",\n \"formatting\": \"Never use capital letters\",\n \"glossary_terms\": \"Apartment, cabin, loft\",\n \"grammar_consistency\": \"\",\n \"literal_translation\": \"Neutral\",\n \"overall_tone\": \"Tone should be fun and light\",\n \"samples\": \"http://www.myexample.com/my/document/path/to/samples.pdf\"\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}/styleguides/{id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"Web application style guide\",\n \"audience\": \"customer-facing\",\n \"target_audience\": \"teenager\",\n \"grammatical_person\": \"first_person_singular\",\n \"vocabulary_type\": \"technical\",\n \"business\": \"We are a travel site that helps customers find the best hotels and flights.\",\n \"company_branding\": \"ACME Inc. should never be translated.\",\n \"formatting\": \"Never use capital letters\",\n \"glossary_terms\": \"Apartment, cabin, loft\",\n \"grammar_consistency\": \"\",\n \"literal_translation\": \"Neutral\",\n \"overall_tone\": \"Tone should be fun and light\",\n \"samples\": \"http://www.myexample.com/my/document/path/to/samples.pdf\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.phrase.com/v2/projects/{project_id}/styleguides/{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 \"title\": \"Web application style guide\",\n \"audience\": \"customer-facing\",\n \"target_audience\": \"teenager\",\n \"grammatical_person\": \"first_person_singular\",\n \"vocabulary_type\": \"technical\",\n \"business\": \"We are a travel site that helps customers find the best hotels and flights.\",\n \"company_branding\": \"ACME Inc. should never be translated.\",\n \"formatting\": \"Never use capital letters\",\n \"glossary_terms\": \"Apartment, cabin, loft\",\n \"grammar_consistency\": \"\",\n \"literal_translation\": \"Neutral\",\n \"overall_tone\": \"Tone should be fun and light\",\n \"samples\": \"http://www.myexample.com/my/document/path/to/samples.pdf\"\n}"
response = http.request(request)
puts response.read_body{
"id": "abcd1234cdef1234abcd1234cdef1234",
"title": "My Style Guide",
"created_at": "2015-01-28T09:52:53Z",
"updated_at": "2015-01-28T09:52:53Z",
"public_url": "https://phrase.com/styleguide/my-project/26f065cf597be340",
"audience": "customer-facing",
"target_audience": "teenager",
"grammatical_person": "first_person_singular",
"vocabulary_type": "technical",
"business": "We are a travel site that helps customers find the best hotels and flights.",
"company_branding": "ACME Inc. should never be translated.",
"formatting": "Never use capital letters",
"glossary_terms": "Apartment, cabin, loft",
"grammar_consistency": "",
"literal_translation": "Neutral",
"overall_tone": "Tone should be fun and light",
"samples": "http://www.myexample.com/my/document/path/to/samples.pdf"
}{
"message": "Validation Failed",
"errors": [
{
"resource": "Resource",
"field": "name",
"message": "can't be blank"
}
]
}Style guides
Update a style guide
Update an existing style guide.
PATCH
/
projects
/
{project_id}
/
styleguides
/
{id}
cURL
curl "https://api.phrase.com/v2/projects/:project_id/styleguides/:id" \
-u USERNAME_OR_ACCESS_TOKEN \
-X PATCH \
-d '{"title":"Web application style guide","audience":"customer-facing","target_audience":"teenager","grammatical_person":"first_person_singular","vocabulary_type":"technical","business":"We are a travel site that helps customers find the best hotels and flights.","company_branding":"ACME Inc. should never be translated.","formatting":"Never use capital letters","glossary_terms":"Apartment, cabin, loft","grammar_consistency":","literal_translation":"Neutral","overall_tone":"Tone should be fun and light","samples":"http://www.myexample.com/my/document/path/to/samples.pdf"}' \
-H 'Content-Type: application/json'phrase styleguides update \
--project_id <project_id> \
--id <id> \
--data '{"title": "Web application style guide", "audience":"customer-facing", "target_audience":"teenager", "grammatical_person":"first_person_singular", "vocabulary_type":"technical", "business": "We are a travel site that helps customers find the best hotels and flights.", "company_branding": "ACME Inc. should never be translated.", "formatting": "Never use capital letters", "glossary_terms": "Apartment, cabin, loft", "grammar_consistency":", "literal_translation":"Neutral", "overall_tone": "Tone should be fun and light", "samples": "http://www.myexample.com/my/document/path/to/samples.pdf"}' \
--access_token <token>import requests
url = "https://api.phrase.com/v2/projects/{project_id}/styleguides/{id}"
payload = {
"title": "Web application style guide",
"audience": "customer-facing",
"target_audience": "teenager",
"grammatical_person": "first_person_singular",
"vocabulary_type": "technical",
"business": "We are a travel site that helps customers find the best hotels and flights.",
"company_branding": "ACME Inc. should never be translated.",
"formatting": "Never use capital letters",
"glossary_terms": "Apartment, cabin, loft",
"grammar_consistency": "",
"literal_translation": "Neutral",
"overall_tone": "Tone should be fun and light",
"samples": "http://www.myexample.com/my/document/path/to/samples.pdf"
}
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({
title: 'Web application style guide',
audience: 'customer-facing',
target_audience: 'teenager',
grammatical_person: 'first_person_singular',
vocabulary_type: 'technical',
business: 'We are a travel site that helps customers find the best hotels and flights.',
company_branding: 'ACME Inc. should never be translated.',
formatting: 'Never use capital letters',
glossary_terms: 'Apartment, cabin, loft',
grammar_consistency: '',
literal_translation: 'Neutral',
overall_tone: 'Tone should be fun and light',
samples: 'http://www.myexample.com/my/document/path/to/samples.pdf'
})
};
fetch('https://api.phrase.com/v2/projects/{project_id}/styleguides/{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}/styleguides/{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([
'title' => 'Web application style guide',
'audience' => 'customer-facing',
'target_audience' => 'teenager',
'grammatical_person' => 'first_person_singular',
'vocabulary_type' => 'technical',
'business' => 'We are a travel site that helps customers find the best hotels and flights.',
'company_branding' => 'ACME Inc. should never be translated.',
'formatting' => 'Never use capital letters',
'glossary_terms' => 'Apartment, cabin, loft',
'grammar_consistency' => '',
'literal_translation' => 'Neutral',
'overall_tone' => 'Tone should be fun and light',
'samples' => 'http://www.myexample.com/my/document/path/to/samples.pdf'
]),
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}/styleguides/{id}"
payload := strings.NewReader("{\n \"title\": \"Web application style guide\",\n \"audience\": \"customer-facing\",\n \"target_audience\": \"teenager\",\n \"grammatical_person\": \"first_person_singular\",\n \"vocabulary_type\": \"technical\",\n \"business\": \"We are a travel site that helps customers find the best hotels and flights.\",\n \"company_branding\": \"ACME Inc. should never be translated.\",\n \"formatting\": \"Never use capital letters\",\n \"glossary_terms\": \"Apartment, cabin, loft\",\n \"grammar_consistency\": \"\",\n \"literal_translation\": \"Neutral\",\n \"overall_tone\": \"Tone should be fun and light\",\n \"samples\": \"http://www.myexample.com/my/document/path/to/samples.pdf\"\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}/styleguides/{id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"Web application style guide\",\n \"audience\": \"customer-facing\",\n \"target_audience\": \"teenager\",\n \"grammatical_person\": \"first_person_singular\",\n \"vocabulary_type\": \"technical\",\n \"business\": \"We are a travel site that helps customers find the best hotels and flights.\",\n \"company_branding\": \"ACME Inc. should never be translated.\",\n \"formatting\": \"Never use capital letters\",\n \"glossary_terms\": \"Apartment, cabin, loft\",\n \"grammar_consistency\": \"\",\n \"literal_translation\": \"Neutral\",\n \"overall_tone\": \"Tone should be fun and light\",\n \"samples\": \"http://www.myexample.com/my/document/path/to/samples.pdf\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.phrase.com/v2/projects/{project_id}/styleguides/{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 \"title\": \"Web application style guide\",\n \"audience\": \"customer-facing\",\n \"target_audience\": \"teenager\",\n \"grammatical_person\": \"first_person_singular\",\n \"vocabulary_type\": \"technical\",\n \"business\": \"We are a travel site that helps customers find the best hotels and flights.\",\n \"company_branding\": \"ACME Inc. should never be translated.\",\n \"formatting\": \"Never use capital letters\",\n \"glossary_terms\": \"Apartment, cabin, loft\",\n \"grammar_consistency\": \"\",\n \"literal_translation\": \"Neutral\",\n \"overall_tone\": \"Tone should be fun and light\",\n \"samples\": \"http://www.myexample.com/my/document/path/to/samples.pdf\"\n}"
response = http.request(request)
puts response.read_body{
"id": "abcd1234cdef1234abcd1234cdef1234",
"title": "My Style Guide",
"created_at": "2015-01-28T09:52:53Z",
"updated_at": "2015-01-28T09:52:53Z",
"public_url": "https://phrase.com/styleguide/my-project/26f065cf597be340",
"audience": "customer-facing",
"target_audience": "teenager",
"grammatical_person": "first_person_singular",
"vocabulary_type": "technical",
"business": "We are a travel site that helps customers find the best hotels and flights.",
"company_branding": "ACME Inc. should never be translated.",
"formatting": "Never use capital letters",
"glossary_terms": "Apartment, cabin, loft",
"grammar_consistency": "",
"literal_translation": "Neutral",
"overall_tone": "Tone should be fun and light",
"samples": "http://www.myexample.com/my/document/path/to/samples.pdf"
}{
"message": "Validation Failed",
"errors": [
{
"resource": "Resource",
"field": "name",
"message": "can't be blank"
}
]
}Authorizations
TokenBasic
Enter your token in the format token TOKEN
Headers
Two-Factor-Authentication token (optional)
Body
application/json
Style guide title
Example:
"Web application style guide"
Audience description. Send an empty string or null to clear the value; omit the field to leave it unchanged. The Phrase CLI drops null values before sending, so use an empty string there.
Example:
"customer-facing"
Target audience for the translations.
Available options:
not_specified, children, teenager, young_adults, adults, old_adults Example:
"teenager"
Preferred grammatical person.
Available options:
not_specified, first_person_singular, second_person_singular, third_person_singular_masculine, third_person_singular_feminine, third_person_singular_neuter, first_person_plural, second_person_plural, third_person_plural Example:
"first_person_singular"
Vocabulary register the translations should use.
Available options:
not_specified, popular, technical, fictional Example:
"technical"
Description of the business. Send an empty string or null to clear the value; omit the field to leave it unchanged. The Phrase CLI drops null values before sending, so use an empty string there.
Example:
"We are a travel site that helps customers find the best hotels and flights."
Company branding to remain consistent. Send an empty string or null to clear the value; omit the field to leave it unchanged. The Phrase CLI drops null values before sending, so use an empty string there.
Example:
"ACME Inc. should never be translated."
Formatting requirements and character limitations. Send an empty string or null to clear the value; omit the field to leave it unchanged. The Phrase CLI drops null values before sending, so use an empty string there.
Example:
"Never use capital letters"
List of terms and/or phrases that need to be translated consistently. Send an empty string or null to clear the value; omit the field to leave it unchanged. The Phrase CLI drops null values before sending, so use an empty string there.
Example:
"Apartment, cabin, loft"
Formal or informal pronouns, consistent conjugation, grammatical gender. Send an empty string or null to clear the value; omit the field to leave it unchanged. The Phrase CLI drops null values before sending, so use an empty string there.
Example:
""
Can be one of: Cultural/Conversational, Literal, Neutral. Send an empty string or null to clear the value; omit the field to leave it unchanged. The Phrase CLI drops null values before sending, so use an empty string there.
Example:
"Neutral"
Tone requirement descriptions. Send an empty string or null to clear the value; omit the field to leave it unchanged. The Phrase CLI drops null values before sending, so use an empty string there.
Example:
"Tone should be fun and light"
Provide links to sample product pages, FAQ pages, etc. to give the translator a point of reference. You can also provide past translations. Even snippets or short paragraphs are helpful for maintaining consistency. Send an empty string or null to clear the value; omit the field to leave it unchanged. The Phrase CLI drops null values before sending, so use an empty string there.
Example:
"http://www.myexample.com/my/document/path/to/samples.pdf"
Response
OK
Was this page helpful?