Create or update a role
curl --request POST \
--url 'https://api.flashcat.cloud/role/upsert?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"role_name": "On-call Manager",
"description": "Manage on-call rotations and incidents.",
"permission_ids": [
501,
502
]
}
'import requests
url = "https://api.flashcat.cloud/role/upsert?app_key="
payload = {
"role_name": "On-call Manager",
"description": "Manage on-call rotations and incidents.",
"permission_ids": [501, 502]
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
role_name: 'On-call Manager',
description: 'Manage on-call rotations and incidents.',
permission_ids: [501, 502]
})
};
fetch('https://api.flashcat.cloud/role/upsert?app_key=', 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.flashcat.cloud/role/upsert?app_key=",
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([
'role_name' => 'On-call Manager',
'description' => 'Manage on-call rotations and incidents.',
'permission_ids' => [
501,
502
]
]),
CURLOPT_HTTPHEADER => [
"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.flashcat.cloud/role/upsert?app_key="
payload := strings.NewReader("{\n \"role_name\": \"On-call Manager\",\n \"description\": \"Manage on-call rotations and incidents.\",\n \"permission_ids\": [\n 501,\n 502\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
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.flashcat.cloud/role/upsert?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"role_name\": \"On-call Manager\",\n \"description\": \"Manage on-call rotations and incidents.\",\n \"permission_ids\": [\n 501,\n 502\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/role/upsert?app_key=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"role_name\": \"On-call Manager\",\n \"description\": \"Manage on-call rotations and incidents.\",\n \"permission_ids\": [\n 501,\n 502\n ]\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"role_id": 150,
"role_name": "On-call Manager"
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "InvalidParameter",
"message": "The specified parameter is not valid."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "Unauthorized",
"message": "You are unauthorized."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "AccessDenied",
"message": "Access Denied."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "RequestTooFrequently",
"message": "Request too frequently."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "InternalError",
"message": "We encountered an internal error, and it has been reported. Please try again later."
}
}Roles & permissions
Create or update a role
Create a new custom role or update an existing one. Pass role_id to update.
POST
/
role
/
upsert
Create or update a role
curl --request POST \
--url 'https://api.flashcat.cloud/role/upsert?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"role_name": "On-call Manager",
"description": "Manage on-call rotations and incidents.",
"permission_ids": [
501,
502
]
}
'import requests
url = "https://api.flashcat.cloud/role/upsert?app_key="
payload = {
"role_name": "On-call Manager",
"description": "Manage on-call rotations and incidents.",
"permission_ids": [501, 502]
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
role_name: 'On-call Manager',
description: 'Manage on-call rotations and incidents.',
permission_ids: [501, 502]
})
};
fetch('https://api.flashcat.cloud/role/upsert?app_key=', 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.flashcat.cloud/role/upsert?app_key=",
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([
'role_name' => 'On-call Manager',
'description' => 'Manage on-call rotations and incidents.',
'permission_ids' => [
501,
502
]
]),
CURLOPT_HTTPHEADER => [
"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.flashcat.cloud/role/upsert?app_key="
payload := strings.NewReader("{\n \"role_name\": \"On-call Manager\",\n \"description\": \"Manage on-call rotations and incidents.\",\n \"permission_ids\": [\n 501,\n 502\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
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.flashcat.cloud/role/upsert?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"role_name\": \"On-call Manager\",\n \"description\": \"Manage on-call rotations and incidents.\",\n \"permission_ids\": [\n 501,\n 502\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/role/upsert?app_key=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"role_name\": \"On-call Manager\",\n \"description\": \"Manage on-call rotations and incidents.\",\n \"permission_ids\": [\n 501,\n 502\n ]\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"role_id": 150,
"role_name": "On-call Manager"
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "InvalidParameter",
"message": "The specified parameter is not valid."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "Unauthorized",
"message": "You are unauthorized."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "AccessDenied",
"message": "Access Denied."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "RequestTooFrequently",
"message": "Request too frequently."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "InternalError",
"message": "We encountered an internal error, and it has been reported. Please try again later."
}
}Restrictions
| Aspect | Value |
|---|---|
| Rate limits | 1,000 requests/minute; 50 requests/second per account |
| Permissions | Roles Manage (organization) |
Usage
- Omit
role_id(or set to 0) to create; pass an existing ID to update. role_namemust be 1–39 characters and unique within the account.permission_idssets the full permission set for the role, replacing any previous assignment.- Every call is recorded in the account audit log. Don’t put secrets in request fields.
Authorizations
App key issued from the Flashduty console under Account → APP Keys. Required on every public API call. Keep it secret — it grants the same access as the owning account.
Body
application/json
Parameters for creating or updating a custom role.
Response
Success
Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.
Was this page helpful?