Skip to main content
POST
/
v2
/
roles
Create Role
curl --request POST \
  --url https://app.textql.com/v2/roles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "analyst",
  "description": "<string>"
}
'
import requests

url = "https://app.textql.com/v2/roles"

payload = {
"name": "analyst",
"description": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: 'analyst', description: '<string>'})
};

fetch('https://app.textql.com/v2/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://app.textql.com/v2/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' => 'analyst',
'description' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://app.textql.com/v2/roles"

payload := strings.NewReader("{\n \"name\": \"analyst\",\n \"description\": \"<string>\"\n}")

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

req.Header.Add("Authorization", "Bearer <token>")
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://app.textql.com/v2/roles")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"analyst\",\n \"description\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://app.textql.com/v2/roles")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"analyst\",\n \"description\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "80de0196-496f-44fe-9d4c-8013b3b44082",
  "name": "analyst",
  "description": "<string>",
  "is_system": true,
  "is_scim_managed": true,
  "created_at": "2026-07-06T19:30:00Z",
  "updated_at": "2026-07-06T19:30:00Z"
}
{
"error": {
"code": "invalid_request",
"message": "Invalid request body"
}
}
{
"error": {
"code": "unauthenticated",
"message": "Authentication required"
}
}
{
"error": {
"code": "permission_denied",
"message": "Insufficient permissions"
}
}
{
"error": {
"code": "rate_limit_exceeded",
"message": "Rate limit exceeded"
}
}
{
"error": {
"code": "internal",
"message": "Internal server error"
}
}

Authorizations

Authorization
string
header
required

API key or JWT token

Body

application/json
name
string
required

Role name, unique within the organization.

Example:

"analyst"

description
string

Response

The created role

id
string
Example:

"80de0196-496f-44fe-9d4c-8013b3b44082"

name
string
Example:

"analyst"

description
string
is_system
boolean

True for the built-in roles (for example admin and member).

is_scim_managed
boolean
created_at
string

RFC 3339 timestamp

Example:

"2026-07-06T19:30:00Z"

updated_at
string

RFC 3339 timestamp

Example:

"2026-07-06T19:30:00Z"