---
title: "Replace the whole permission document"
description: "Replace every role and permission at once."
canonical: "https://grid82.com/docs/builder-api/rules/set"
updated: "2026-11-13"
---

# Replace the whole permission document

`PUT https://studio.grid82.app/v1/apps/{appId}/rules`

Replace every role and permission at once.

To add, rename or remove one role, prefer `roles.create`, `roles.update` and `roles.delete`. Each `permissions[].tables` has the shape shown in `roles.setPermissions`. To change one role's permissions, prefer `roles.setPermissions`, which cannot affect others. Send the `revision` returned by `rules.get` as `baseRevision`; if someone else changed the document since, the save is refused with 409 instead of overwriting their change.

Requires the `schema:write` scope. Operation `rules.set`. Not an MCP tool. Replacing every role at once is how one agent's edit erases another role's. A model adds, renames, removes and narrows roles one at a time with roles.create, roles.update, roles.delete and roles.setPermissions, none of which can reach another role. The whole document stays on the API and the CLI. CLI: `grid82 rules set` (`npx grid82`).

## Path parameters

| Name    | Type   | Required | Description |
| ------- | ------ | -------- | ----------- |
| `appId` | 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      |
| -------------- | --------- | -------- | ---------------- |
| `version`      | 2         | yes      |                  |
| `roles`        | object\[] | yes      | 1 to 100 items.  |
| `permissions`  | object\[] | yes      | Up to 100 items. |
| `baseRevision` | string    | no       |                  |

**Authorizations**

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

## Response

**200**: Success

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

```json
{
  "data": {
    "version": 123.45,
    "roles": [
      {
        "id": "<string>",
        "name": "<string>",
        "description": "<string>",
        "assistantMonthlyCredits": 123,
        "interface": "assigned",
        "automations": "none"
      }
    ],
    "permissions": [
      {
        "role": "<string>",
        "tables": "<string>"
      }
    ],
    "revision": "<string>"
  }
}
```

**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 PUT \
  --url 'https://studio.grid82.app/v1/apps/<appId>/rules' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "version": 123.45,
  "roles": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "permissions": [
    {
      "role": "<string>",
      "tables": "<string>"
    }
  ]
}'
```