---
title: "Rename or describe a role"
description: "Change a role's name, description, or what its members may do with pages (`interface`) and workflows (`automations`)."
canonical: "https://grid82.com/docs/builder-api/roles/update"
updated: "2026-11-13"
---

# Rename or describe a role

`PATCH https://studio.grid82.app/v1/apps/{appId}/roles/{roleId}`

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

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       |                       |

**Authorizations**

- `Authorization` (bearer, in header, required)

## Response

**200**: Success

- `data` (`object`, required)
- `data.id` (`string`, required, pattern: `^[a-z][a-z0-9_]{0,62}$`)
- `data.name` (`string`, required, length: `1–120 chars`)
- `data.description` (`string`, length: `≤ 500 chars`)
- `data.assistantMonthlyCredits` (`integer`, range: `0–10000000`)
- `data.interface` (`enum<string>`, one of: `assigned, own`)
- `data.automations` (`enum<string>`, one of: `none, own`)

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

**4XX**: Refused

- `error` (`object`, required)
- `error.code` (`enum<string>`, required, one of: `not_found, forbidden, unauthenticated, validation_failed, conflict, rate_limited, payment_required, not_implemented, internal`)
- `error.message` (`string`, required)
- `error.details` (`Record<string, unknown>`)

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

**Example request**

```bash
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"
}'
```