Skip to main content
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": {},
    "created_at": "<string>"
  }
}

Authorizations

x-api-key
string
header
required

API key for authentication. You can create one here.

Path Parameters

role_id
string
required

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

permissions
object
required

Per-category access levels for a role. Every category is at least 'view'; categories omitted on create/update default to 'view'.

Response

Role updated successfully

success
boolean
required
Example:

true

role
object
required

A role available in your organization — a built-in system role or a custom role.