cURL
curl "https://api.phrase.com/v2/projects/:project_id/invitations/:id" \
-u USERNAME_OR_ACCESS_TOKEN \
-X PATCH \
-d '{"project_role":"Developer","locale_ids":["fff565db236400772368235db2c6117e","fff565db236400772368235db2c6117f"]}' \
-H 'Content-Type: application/json'phrase invitations update_settings \
--project_id <project_id> \
--id <id> \
--data '{"project_role":"Developer","locale_ids":["fff565db236400772368235db2c6117e","fff565db236400772368235db2c6117f"]}' \
--access_token <token>import requests
url = "https://api.phrase.com/v2/projects/{project_id}/invitations/{id}"
payload = {
"project_role": "Developer",
"locale_ids": ["abcd1234abcd1234abcd1234", "abcd1234abcd1234abcd1235"]
}
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({
project_role: 'Developer',
locale_ids: ['abcd1234abcd1234abcd1234', 'abcd1234abcd1234abcd1235']
})
};
fetch('https://api.phrase.com/v2/projects/{project_id}/invitations/{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}/invitations/{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([
'project_role' => 'Developer',
'locale_ids' => [
'abcd1234abcd1234abcd1234',
'abcd1234abcd1234abcd1235'
]
]),
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}/invitations/{id}"
payload := strings.NewReader("{\n \"project_role\": \"Developer\",\n \"locale_ids\": [\n \"abcd1234abcd1234abcd1234\",\n \"abcd1234abcd1234abcd1235\"\n ]\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}/invitations/{id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"project_role\": \"Developer\",\n \"locale_ids\": [\n \"abcd1234abcd1234abcd1234\",\n \"abcd1234abcd1234abcd1235\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.phrase.com/v2/projects/{project_id}/invitations/{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 \"project_role\": \"Developer\",\n \"locale_ids\": [\n \"abcd1234abcd1234abcd1234\",\n \"abcd1234abcd1234abcd1235\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "acbdacbdacbdacbdacbdacbd",
"email": "foo@bar.com",
"role": "Manager",
"state": "accepted",
"projects": [
{
"id": "abcd1234cdef1234abcd1234cdef1234",
"name": "My Android Project",
"main_format": "xml",
"created_at": "2015-01-28T09:52:53Z",
"updated_at": "2015-01-28T09:52:53Z"
}
],
"locales": [
{
"id": "abcd1234cdef1234abcd1234cdef1234",
"name": "English",
"code": "en-GB"
}
],
"default_locale_codes": [
"en",
"de"
],
"permissions": [
{
"create_upload": true,
"review_translations": true
}
],
"locale_ids": [
"abcd1234abcd1234abcd1234",
"abcd1234abcd1234abcd1235"
],
"created_at": "2015-01-28T09:52:53Z",
"updated_at": "2015-01-28T09:52:53Z",
"accepted_at": "2015-02-28T09:52:53Z",
"spaces": [
{
"id": "04d36d845576b9d494d05e0b70fe813b",
"name": "Space2",
"created_at": "2020-12-07T12:56:21Z",
"updated_at": "2020-12-07T12:56:21Z",
"projects_count": 1
}
],
"teams": [
{
"id": "04d36d845576b9d494d05e0b70fe813c",
"name": "Team 1",
"created_at": "2020-12-07T12:56:21Z",
"updated_at": "2020-12-07T12:56:21Z"
}
],
"project_roles": [
{
"project_id": "abcd1234cdef1234abcd1234cdef1234",
"role": "Developer"
}
]
}{
"message": "Validation Failed",
"errors": [
{
"resource": "Resource",
"field": "name",
"message": "can't be blank"
}
]
}Invitations
Update a member's invitation access
Update member’s settings in the invitations. Access token scope must include team.manage.
PATCH
/
projects
/
{project_id}
/
invitations
/
{id}
cURL
curl "https://api.phrase.com/v2/projects/:project_id/invitations/:id" \
-u USERNAME_OR_ACCESS_TOKEN \
-X PATCH \
-d '{"project_role":"Developer","locale_ids":["fff565db236400772368235db2c6117e","fff565db236400772368235db2c6117f"]}' \
-H 'Content-Type: application/json'phrase invitations update_settings \
--project_id <project_id> \
--id <id> \
--data '{"project_role":"Developer","locale_ids":["fff565db236400772368235db2c6117e","fff565db236400772368235db2c6117f"]}' \
--access_token <token>import requests
url = "https://api.phrase.com/v2/projects/{project_id}/invitations/{id}"
payload = {
"project_role": "Developer",
"locale_ids": ["abcd1234abcd1234abcd1234", "abcd1234abcd1234abcd1235"]
}
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({
project_role: 'Developer',
locale_ids: ['abcd1234abcd1234abcd1234', 'abcd1234abcd1234abcd1235']
})
};
fetch('https://api.phrase.com/v2/projects/{project_id}/invitations/{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}/invitations/{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([
'project_role' => 'Developer',
'locale_ids' => [
'abcd1234abcd1234abcd1234',
'abcd1234abcd1234abcd1235'
]
]),
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}/invitations/{id}"
payload := strings.NewReader("{\n \"project_role\": \"Developer\",\n \"locale_ids\": [\n \"abcd1234abcd1234abcd1234\",\n \"abcd1234abcd1234abcd1235\"\n ]\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}/invitations/{id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"project_role\": \"Developer\",\n \"locale_ids\": [\n \"abcd1234abcd1234abcd1234\",\n \"abcd1234abcd1234abcd1235\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.phrase.com/v2/projects/{project_id}/invitations/{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 \"project_role\": \"Developer\",\n \"locale_ids\": [\n \"abcd1234abcd1234abcd1234\",\n \"abcd1234abcd1234abcd1235\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "acbdacbdacbdacbdacbdacbd",
"email": "foo@bar.com",
"role": "Manager",
"state": "accepted",
"projects": [
{
"id": "abcd1234cdef1234abcd1234cdef1234",
"name": "My Android Project",
"main_format": "xml",
"created_at": "2015-01-28T09:52:53Z",
"updated_at": "2015-01-28T09:52:53Z"
}
],
"locales": [
{
"id": "abcd1234cdef1234abcd1234cdef1234",
"name": "English",
"code": "en-GB"
}
],
"default_locale_codes": [
"en",
"de"
],
"permissions": [
{
"create_upload": true,
"review_translations": true
}
],
"locale_ids": [
"abcd1234abcd1234abcd1234",
"abcd1234abcd1234abcd1235"
],
"created_at": "2015-01-28T09:52:53Z",
"updated_at": "2015-01-28T09:52:53Z",
"accepted_at": "2015-02-28T09:52:53Z",
"spaces": [
{
"id": "04d36d845576b9d494d05e0b70fe813b",
"name": "Space2",
"created_at": "2020-12-07T12:56:21Z",
"updated_at": "2020-12-07T12:56:21Z",
"projects_count": 1
}
],
"teams": [
{
"id": "04d36d845576b9d494d05e0b70fe813c",
"name": "Team 1",
"created_at": "2020-12-07T12:56:21Z",
"updated_at": "2020-12-07T12:56:21Z"
}
],
"project_roles": [
{
"project_id": "abcd1234cdef1234abcd1234cdef1234",
"role": "Developer"
}
]
}{
"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
Response
OK
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Per-project roles assigned to the invitee.
Show child attributes
Show child attributes
Was this page helpful?
⌘I