Update Role
curl --request PATCH \
--url https://api.xenia.team/api/v1/mgt/workspaces/{workspaceId}/roles/{roleId} \
--header 'Content-Type: application/json' \
--header 'x-client-key: <api-key>' \
--header 'x-client-secret: <api-key>' \
--data '
{
"permissions": [
"7790c9eb-8d55-4fe0-a52d-2e5e769e9588",
"dbf2e476-c880-4f1c-9ac6-a44bc3c0c9a7"
],
"title": "New Role Title - edit",
"description": "New Role test description",
"reportTo": "43bc03d0-e0c5-41a1-bc13-2d232a40a728",
"homepage": {
"mobile": "PULSE",
"web": "PULSE",
"dashboard": {}
}
}
'import requests
url = "https://api.xenia.team/api/v1/mgt/workspaces/{workspaceId}/roles/{roleId}"
payload = {
"permissions": ["7790c9eb-8d55-4fe0-a52d-2e5e769e9588", "dbf2e476-c880-4f1c-9ac6-a44bc3c0c9a7"],
"title": "New Role Title - edit",
"description": "New Role test description",
"reportTo": "43bc03d0-e0c5-41a1-bc13-2d232a40a728",
"homepage": {
"mobile": "PULSE",
"web": "PULSE",
"dashboard": {}
}
}
headers = {
"x-client-key": "<api-key>",
"x-client-secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'x-client-key': '<api-key>',
'x-client-secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
permissions: ['7790c9eb-8d55-4fe0-a52d-2e5e769e9588', 'dbf2e476-c880-4f1c-9ac6-a44bc3c0c9a7'],
title: 'New Role Title - edit',
description: 'New Role test description',
reportTo: '43bc03d0-e0c5-41a1-bc13-2d232a40a728',
homepage: {mobile: 'PULSE', web: 'PULSE', dashboard: {}}
})
};
fetch('https://api.xenia.team/api/v1/mgt/workspaces/{workspaceId}/roles/{roleId}', 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.xenia.team/api/v1/mgt/workspaces/{workspaceId}/roles/{roleId}",
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([
'permissions' => [
'7790c9eb-8d55-4fe0-a52d-2e5e769e9588',
'dbf2e476-c880-4f1c-9ac6-a44bc3c0c9a7'
],
'title' => 'New Role Title - edit',
'description' => 'New Role test description',
'reportTo' => '43bc03d0-e0c5-41a1-bc13-2d232a40a728',
'homepage' => [
'mobile' => 'PULSE',
'web' => 'PULSE',
'dashboard' => [
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-client-key: <api-key>",
"x-client-secret: <api-key>"
],
]);
$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.xenia.team/api/v1/mgt/workspaces/{workspaceId}/roles/{roleId}"
payload := strings.NewReader("{\n \"permissions\": [\n \"7790c9eb-8d55-4fe0-a52d-2e5e769e9588\",\n \"dbf2e476-c880-4f1c-9ac6-a44bc3c0c9a7\"\n ],\n \"title\": \"New Role Title - edit\",\n \"description\": \"New Role test description\",\n \"reportTo\": \"43bc03d0-e0c5-41a1-bc13-2d232a40a728\",\n \"homepage\": {\n \"mobile\": \"PULSE\",\n \"web\": \"PULSE\",\n \"dashboard\": {}\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-client-key", "<api-key>")
req.Header.Add("x-client-secret", "<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.xenia.team/api/v1/mgt/workspaces/{workspaceId}/roles/{roleId}")
.header("x-client-key", "<api-key>")
.header("x-client-secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"permissions\": [\n \"7790c9eb-8d55-4fe0-a52d-2e5e769e9588\",\n \"dbf2e476-c880-4f1c-9ac6-a44bc3c0c9a7\"\n ],\n \"title\": \"New Role Title - edit\",\n \"description\": \"New Role test description\",\n \"reportTo\": \"43bc03d0-e0c5-41a1-bc13-2d232a40a728\",\n \"homepage\": {\n \"mobile\": \"PULSE\",\n \"web\": \"PULSE\",\n \"dashboard\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.xenia.team/api/v1/mgt/workspaces/{workspaceId}/roles/{roleId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-client-key"] = '<api-key>'
request["x-client-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"permissions\": [\n \"7790c9eb-8d55-4fe0-a52d-2e5e769e9588\",\n \"dbf2e476-c880-4f1c-9ac6-a44bc3c0c9a7\"\n ],\n \"title\": \"New Role Title - edit\",\n \"description\": \"New Role test description\",\n \"reportTo\": \"43bc03d0-e0c5-41a1-bc13-2d232a40a728\",\n \"homepage\": {\n \"mobile\": \"PULSE\",\n \"web\": \"PULSE\",\n \"dashboard\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"meta": {}
}Roles
Update Role
Edit an existing role by ID for a specific workspace
PATCH
/
api
/
v1
/
mgt
/
workspaces
/
{workspaceId}
/
roles
/
{roleId}
Update Role
curl --request PATCH \
--url https://api.xenia.team/api/v1/mgt/workspaces/{workspaceId}/roles/{roleId} \
--header 'Content-Type: application/json' \
--header 'x-client-key: <api-key>' \
--header 'x-client-secret: <api-key>' \
--data '
{
"permissions": [
"7790c9eb-8d55-4fe0-a52d-2e5e769e9588",
"dbf2e476-c880-4f1c-9ac6-a44bc3c0c9a7"
],
"title": "New Role Title - edit",
"description": "New Role test description",
"reportTo": "43bc03d0-e0c5-41a1-bc13-2d232a40a728",
"homepage": {
"mobile": "PULSE",
"web": "PULSE",
"dashboard": {}
}
}
'import requests
url = "https://api.xenia.team/api/v1/mgt/workspaces/{workspaceId}/roles/{roleId}"
payload = {
"permissions": ["7790c9eb-8d55-4fe0-a52d-2e5e769e9588", "dbf2e476-c880-4f1c-9ac6-a44bc3c0c9a7"],
"title": "New Role Title - edit",
"description": "New Role test description",
"reportTo": "43bc03d0-e0c5-41a1-bc13-2d232a40a728",
"homepage": {
"mobile": "PULSE",
"web": "PULSE",
"dashboard": {}
}
}
headers = {
"x-client-key": "<api-key>",
"x-client-secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'x-client-key': '<api-key>',
'x-client-secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
permissions: ['7790c9eb-8d55-4fe0-a52d-2e5e769e9588', 'dbf2e476-c880-4f1c-9ac6-a44bc3c0c9a7'],
title: 'New Role Title - edit',
description: 'New Role test description',
reportTo: '43bc03d0-e0c5-41a1-bc13-2d232a40a728',
homepage: {mobile: 'PULSE', web: 'PULSE', dashboard: {}}
})
};
fetch('https://api.xenia.team/api/v1/mgt/workspaces/{workspaceId}/roles/{roleId}', 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.xenia.team/api/v1/mgt/workspaces/{workspaceId}/roles/{roleId}",
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([
'permissions' => [
'7790c9eb-8d55-4fe0-a52d-2e5e769e9588',
'dbf2e476-c880-4f1c-9ac6-a44bc3c0c9a7'
],
'title' => 'New Role Title - edit',
'description' => 'New Role test description',
'reportTo' => '43bc03d0-e0c5-41a1-bc13-2d232a40a728',
'homepage' => [
'mobile' => 'PULSE',
'web' => 'PULSE',
'dashboard' => [
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-client-key: <api-key>",
"x-client-secret: <api-key>"
],
]);
$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.xenia.team/api/v1/mgt/workspaces/{workspaceId}/roles/{roleId}"
payload := strings.NewReader("{\n \"permissions\": [\n \"7790c9eb-8d55-4fe0-a52d-2e5e769e9588\",\n \"dbf2e476-c880-4f1c-9ac6-a44bc3c0c9a7\"\n ],\n \"title\": \"New Role Title - edit\",\n \"description\": \"New Role test description\",\n \"reportTo\": \"43bc03d0-e0c5-41a1-bc13-2d232a40a728\",\n \"homepage\": {\n \"mobile\": \"PULSE\",\n \"web\": \"PULSE\",\n \"dashboard\": {}\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-client-key", "<api-key>")
req.Header.Add("x-client-secret", "<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.xenia.team/api/v1/mgt/workspaces/{workspaceId}/roles/{roleId}")
.header("x-client-key", "<api-key>")
.header("x-client-secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"permissions\": [\n \"7790c9eb-8d55-4fe0-a52d-2e5e769e9588\",\n \"dbf2e476-c880-4f1c-9ac6-a44bc3c0c9a7\"\n ],\n \"title\": \"New Role Title - edit\",\n \"description\": \"New Role test description\",\n \"reportTo\": \"43bc03d0-e0c5-41a1-bc13-2d232a40a728\",\n \"homepage\": {\n \"mobile\": \"PULSE\",\n \"web\": \"PULSE\",\n \"dashboard\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.xenia.team/api/v1/mgt/workspaces/{workspaceId}/roles/{roleId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-client-key"] = '<api-key>'
request["x-client-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"permissions\": [\n \"7790c9eb-8d55-4fe0-a52d-2e5e769e9588\",\n \"dbf2e476-c880-4f1c-9ac6-a44bc3c0c9a7\"\n ],\n \"title\": \"New Role Title - edit\",\n \"description\": \"New Role test description\",\n \"reportTo\": \"43bc03d0-e0c5-41a1-bc13-2d232a40a728\",\n \"homepage\": {\n \"mobile\": \"PULSE\",\n \"web\": \"PULSE\",\n \"dashboard\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"meta": {}
}Authorizations
Client API key for authentication
Client secret for authentication
Body
application/json
Response
Role successfully updated
⌘I