Rename or describe a role

Change a role's name, description, or what its members may do with pages (interface) and workflows (automations).

PATCH/v1/apps/{appId}/roles/{roleId}

Request

curl --request PATCH \
  --url 'https://studio.grid82.app/v1/apps/<appId>/roles/<roleId>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "interface": "assigned",
  "automations": "none"
}'

import json
import requests

url = "https://studio.grid82.app/v1/apps/<appId>/roles/<roleId>"
headers = {
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
}
payload = json.loads("{\"name\":\"<string>\",\"description\":\"<string>\",\"interface\":\"assigned\",\"automations\":\"none\"}")

response = requests.request("PATCH", url, headers=headers, json=payload)
print(response.json())

const response = await fetch("https://studio.grid82.app/v1/apps/<appId>/roles/<roleId>", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "name": "<string>",
    "description": "<string>",
    "interface": "assigned",
    "automations": "none"
  }),
});

const data = await response.json();
console.log(data);

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://studio.grid82.app/v1/apps/<appId>/roles/<roleId>");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($client, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
]);
curl_setopt($client, CURLOPT_POSTFIELDS, "{\"name\":\"<string>\",\"description\":\"<string>\",\"interface\":\"assigned\",\"automations\":\"none\"}");
curl_setopt($client, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($client);
curl_close($client);
echo $response;

package main

import (
  "bytes"
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("PATCH", "https://studio.grid82.app/v1/apps/<appId>/roles/<roleId>", bytes.NewBuffer([]byte("{\"name\":\"<string>\",\"description\":\"<string>\",\"interface\":\"assigned\",\"automations\":\"none\"}")))
  req.Header.Set("Authorization", "Bearer <token>")
  req.Header.Set("Content-Type", "application/json")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  data, _ := io.ReadAll(res.Body)
  fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var request = HttpRequest.newBuilder(URI.create("https://studio.grid82.app/v1/apps/<appId>/roles/<roleId>"))
    .header("Authorization", "Bearer <token>")
    .header("Content-Type", "application/json")
    .method("PATCH", HttpRequest.BodyPublishers.ofString("{\"name\":\"<string>\",\"description\":\"<string>\",\"interface\":\"assigned\",\"automations\":\"none\"}"))
    .build();

var response = HttpClient.newHttpClient().send(
    request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

require 'net/http'
require 'json'

uri = URI("https://studio.grid82.app/v1/apps/<appId>/roles/<roleId>")
request = Net::HTTP::Patch.new(uri)
request["Authorization"] = "Bearer <token>"
request["Content-Type"] = "application/json"
request.body = "{\"name\":\"<string>\",\"description\":\"<string>\",\"interface\":\"assigned\",\"automations\":\"none\"}"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

puts response.body

application/json

{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "assistantMonthlyCredits": 123,
    "interface": "assigned",
    "automations": "none"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "<string>",
    "details": {}
  }
}

Its permissions change with roles.setPermissions.

Requires the schema:write scope. Operation roles.update. MCP tool roles_update. CLI: grid82 roles update (npx grid82).

Path parameters

Name	Type	Required	Description
`appId`	string	yes
`roleId`	string	yes

Headers

Name	Type	Required	Description
`Idempotency-Key`	string	no	Any unique string. Sending the same key with the same request again returns the first response (marked `Idempotency-Replayed: true`) instead of running it twice. Reusing it for a different request is refused with 409. Kept for 24 hours. Up to 255 characters.

Request body

Field	Type	Required	Description
`name`	string	no	Up to 120 characters.
`description`	string	no	Up to 500 characters.
`interface`	“assigned” or “own”	no
`automations`	“none” or “own”	no

Response

application/json

Success

dataobjectrequired

Show child attributes

data.idstringrequiredpattern: ^[a-z][a-z0-9_]{0,62}$

data.namestringrequiredlength: 1–120 chars

data.descriptionstringlength: ≤ 500 chars

data.assistantMonthlyCreditsintegerrange: 0–10000000

data.interfaceenum<string>one of: assigned, own

data.automationsenum<string>one of: none, own

curl --request PATCH \ --url 'https://studio.grid82.app/v1/apps/<appId>/roles/<roleId>' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "name": "<string>", "description": "<string>", "interface": "assigned", "automations": "none" }'

Rename or describe a role

Path parameters

Headers

Request body

Response

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown