Skip to main content
POST
/
api
/
v1
/
roles
Create Custom Role
curl --request POST \
  --url https://api.athenahq.ai/api/v1/roles \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "Content Manager",
  "permissions": {}
}
'
import requests

url = "https://api.athenahq.ai/api/v1/roles"

payload = {
    "name": "Content Manager",
    "permissions": {}
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'Content Manager', permissions: {}})
};

fetch('https://api.athenahq.ai/api/v1/roles', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Content Manager',
    '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"

	payload := strings.NewReader("{\n  \"name\": \"Content Manager\",\n  \"permissions\": {}\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.athenahq.ai/api/v1/roles")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Content Manager\",\n  \"permissions\": {}\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.athenahq.ai/api/v1/roles")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Content Manager\",\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.

Body

application/json

Request body for creating a custom role

​
name
string
required

Display name of the role. Must be unique in your organization (case-insensitive) and must not collide with a system role name.

Example:

"Content Manager"

​
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 created successfully

​
success
boolean
required
Example:

true

​
role
object
required

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