Update Role
curl --request PATCH \
--url https://app.textql.com/v2/roles/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"default_model_id": 123,
"allowed_model_ids": [
123
],
"allow_model_choice": true,
"clear_allowed_model_ids": true
}
'import requests
url = "https://app.textql.com/v2/roles/{id}"
payload = {
"name": "<string>",
"description": "<string>",
"default_model_id": 123,
"allowed_model_ids": [123],
"allow_model_choice": True,
"clear_allowed_model_ids": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
default_model_id: 123,
allowed_model_ids: [123],
allow_model_choice: true,
clear_allowed_model_ids: true
})
};
fetch('https://app.textql.com/v2/roles/{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://app.textql.com/v2/roles/{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([
'name' => '<string>',
'description' => '<string>',
'default_model_id' => 123,
'allowed_model_ids' => [
123
],
'allow_model_choice' => true,
'clear_allowed_model_ids' => true
]),
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/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"default_model_id\": 123,\n \"allowed_model_ids\": [\n 123\n ],\n \"allow_model_choice\": true,\n \"clear_allowed_model_ids\": true\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://app.textql.com/v2/roles/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"default_model_id\": 123,\n \"allowed_model_ids\": [\n 123\n ],\n \"allow_model_choice\": true,\n \"clear_allowed_model_ids\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.textql.com/v2/roles/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"default_model_id\": 123,\n \"allowed_model_ids\": [\n 123\n ],\n \"allow_model_choice\": true,\n \"clear_allowed_model_ids\": true\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": "not_found",
"message": "Resource not found"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "Rate limit exceeded"
}
}{
"error": {
"code": "internal",
"message": "Internal server error"
}
}Roles
Update Role
Update a role’s name, description, or model configuration
PATCH
/
v2
/
roles
/
{id}
Update Role
curl --request PATCH \
--url https://app.textql.com/v2/roles/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"default_model_id": 123,
"allowed_model_ids": [
123
],
"allow_model_choice": true,
"clear_allowed_model_ids": true
}
'import requests
url = "https://app.textql.com/v2/roles/{id}"
payload = {
"name": "<string>",
"description": "<string>",
"default_model_id": 123,
"allowed_model_ids": [123],
"allow_model_choice": True,
"clear_allowed_model_ids": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
default_model_id: 123,
allowed_model_ids: [123],
allow_model_choice: true,
clear_allowed_model_ids: true
})
};
fetch('https://app.textql.com/v2/roles/{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://app.textql.com/v2/roles/{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([
'name' => '<string>',
'description' => '<string>',
'default_model_id' => 123,
'allowed_model_ids' => [
123
],
'allow_model_choice' => true,
'clear_allowed_model_ids' => true
]),
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/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"default_model_id\": 123,\n \"allowed_model_ids\": [\n 123\n ],\n \"allow_model_choice\": true,\n \"clear_allowed_model_ids\": true\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://app.textql.com/v2/roles/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"default_model_id\": 123,\n \"allowed_model_ids\": [\n 123\n ],\n \"allow_model_choice\": true,\n \"clear_allowed_model_ids\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.textql.com/v2/roles/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"default_model_id\": 123,\n \"allowed_model_ids\": [\n 123\n ],\n \"allow_model_choice\": true,\n \"clear_allowed_model_ids\": true\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": "not_found",
"message": "Resource not found"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "Rate limit exceeded"
}
}{
"error": {
"code": "internal",
"message": "Internal server error"
}
}Authorizations
API key or JWT token
Path Parameters
Role UUID
Body
application/json
New role name; omit to keep the current name.
New description; omit to keep the current description.
Default LLM model id for members of this role; 0 clears it.
Restrict members of this role to these model ids.
Whether members of this role may pick a model per chat.
Set true to reset allowed_model_ids back to all models.
Response
The updated role
Example:
"80de0196-496f-44fe-9d4c-8013b3b44082"
Example:
"analyst"
True for the built-in roles (for example admin and member).
RFC 3339 timestamp
Example:
"2026-07-06T19:30:00Z"
RFC 3339 timestamp
Example:
"2026-07-06T19:30:00Z"
⌘I