Create a custom role

curl --request POST \
  --url https://api.hyperprop.com/platform/v1/organization/roles \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Payout Desk",
  "permissions": {
    "payouts": "manage",
    "traders": "view",
    "analytics": "view"
  },
  "description": "Reviews and executes payouts only"
}
'

import requests

url = "https://api.hyperprop.com/platform/v1/organization/roles"

payload = {
    "name": "Payout Desk",
    "permissions": {
        "payouts": "manage",
        "traders": "view",
        "analytics": "view"
    },
    "description": "Reviews and executes payouts only"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Payout Desk',
    permissions: {payouts: 'manage', traders: 'view', analytics: 'view'},
    description: 'Reviews and executes payouts only'
  })
};

fetch('https://api.hyperprop.com/platform/v1/organization/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.hyperprop.com/platform/v1/organization/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' => 'Payout Desk',
    'permissions' => [
        'payouts' => 'manage',
        'traders' => 'view',
        'analytics' => 'view'
    ],
    'description' => 'Reviews and executes payouts only'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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.hyperprop.com/platform/v1/organization/roles"

	payload := strings.NewReader("{\n  \"name\": \"Payout Desk\",\n  \"permissions\": {\n    \"payouts\": \"manage\",\n    \"traders\": \"view\",\n    \"analytics\": \"view\"\n  },\n  \"description\": \"Reviews and executes payouts only\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<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.hyperprop.com/platform/v1/organization/roles")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Payout Desk\",\n  \"permissions\": {\n    \"payouts\": \"manage\",\n    \"traders\": \"view\",\n    \"analytics\": \"view\"\n  },\n  \"description\": \"Reviews and executes payouts only\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hyperprop.com/platform/v1/organization/roles")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Payout Desk\",\n  \"permissions\": {\n    \"payouts\": \"manage\",\n    \"traders\": \"view\",\n    \"analytics\": \"view\"\n  },\n  \"description\": \"Reviews and executes payouts only\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "id": "<string>",
    "name": "Payout Desk",
    "description": "<string>",
    "permissions": {},
    "isSystem": false,
    "memberCount": 0
  }
}

{
  "success": false,
  "statusCode": 403,
  "error": "Forbidden",
  "message": "Access denied",
  "code": "FORBIDDEN"
}

{
  "statusCode": 409,
  "error": "Conflict",
  "message": "A role with this name already exists",
  "code": "ROLE_NAME_EXISTS"
}

{
  "success": false,
  "statusCode": 500,
  "error": "Internal Server Error",
  "message": "An unexpected error occurred",
  "code": "INTERNAL_ERROR"
}