Update Custom Role
curl --request PATCH \
--url https://api.athenahq.ai/api/v1/roles/{role_id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"permissions": {}
}
'import requests
url = "https://api.athenahq.ai/api/v1/roles/{role_id}"
payload = { "permissions": {} }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({permissions: {}})
};
fetch('https://api.athenahq.ai/api/v1/roles/{role_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.athenahq.ai/api/v1/roles/{role_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([
'permissions' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <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.athenahq.ai/api/v1/roles/{role_id}"
payload := strings.NewReader("{\n \"permissions\": {}\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<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.athenahq.ai/api/v1/roles/{role_id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"permissions\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.athenahq.ai/api/v1/roles/{role_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"permissions\": {}\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"role": {
"role_id": "<string>",
"name": "Content Manager",
"slug": "content-manager",
"is_system": true,
"permissions": {
"content": "none",
"prompts": "none",
"competitors": "none",
"analytics": "none",
"integrations": "none",
"brand_knowledge": "none",
"team": "none",
"billing": "none",
"api": "none",
"organization": "none"
},
"created_at": "<string>"
}
}Roles
Update Custom Role
Updates a custom role’s permission matrix. Every category is at least ‘view’ — omitted categories default to ‘view’. System roles cannot be edited. The new matrix must not duplicate an existing role’s. Requires a global API key.
PATCH
/
api
/
v1
/
roles
/
{role_id}
Update Custom Role
curl --request PATCH \
--url https://api.athenahq.ai/api/v1/roles/{role_id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"permissions": {}
}
'import requests
url = "https://api.athenahq.ai/api/v1/roles/{role_id}"
payload = { "permissions": {} }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({permissions: {}})
};
fetch('https://api.athenahq.ai/api/v1/roles/{role_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.athenahq.ai/api/v1/roles/{role_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([
'permissions' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <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.athenahq.ai/api/v1/roles/{role_id}"
payload := strings.NewReader("{\n \"permissions\": {}\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<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.athenahq.ai/api/v1/roles/{role_id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"permissions\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.athenahq.ai/api/v1/roles/{role_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"permissions\": {}\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"role": {
"role_id": "<string>",
"name": "Content Manager",
"slug": "content-manager",
"is_system": true,
"permissions": {
"content": "none",
"prompts": "none",
"competitors": "none",
"analytics": "none",
"integrations": "none",
"brand_knowledge": "none",
"team": "none",
"billing": "none",
"api": "none",
"organization": "none"
},
"created_at": "<string>"
}
}Path Parameters
The unique identifier of the role (a system role ID or a custom role ID)
Pattern:
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$Body
application/json
Request body for updating a custom role's permissions
Per-category access levels for a role. Every category is at least 'view'; categories omitted on create/update default to 'view'.
Show child attributes
Show child attributes
Was this page helpful?
⌘I