---
title: "Change a suite"
description: "Renames a suite, changes its subdomain, sets its login page's colour and logo, or flips its providers."
canonical: "https://grid82.com/docs/builder-api/suites/update"
updated: "2026-11-13"
---

# Change a suite

`PATCH https://studio.grid82.app/v1/suites/{suiteId}`

Renames a suite, changes its subdomain, sets its login page's colour and logo, or flips its providers.

A subdomain already taken by another suite is refused rather than suffixed: an address is not a name, and quietly giving somebody `acme-2` would be worse than saying no. Turning a provider off signs nobody out; it stops the next sign-in with it.

Requires the `schema:write` scope. Operation `suites.update`. MCP tool `suites_update`. CLI: `grid82 suites update` (`npx grid82`).

## Path parameters

| Name      | Type   | Required | Description |
| --------- | ------ | -------- | ----------- |
| `suiteId` | 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 60 characters. |
| `slug`                    | string          | no       | Up to 40 characters. |
| `authPassword`            | boolean         | no       |                      |
| `authGoogle`              | boolean         | no       |                      |
| `allowSelfSignup`         | boolean         | no       |                      |
| `accent`                  | string or null  | no       |                      |
| `logoUrl`                 | string or null  | no       |                      |
| `assistantMonthlyCredits` | integer or null | no       |                      |
| `assistantPresets`        | object\[]       | no       |                      |

**Authorizations**

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

## Response

**200**: Success

- `data` (`object`, required)
- `data.id` (`string`, required)
- `data.organizationId` (`string`, required)
- `data.name` (`string`, required, length: `1–120 chars`)
- `data.slug` (`string`, required, length: `2–40 chars`, pattern: `^[a-z0-9][a-z0-9-]*[a-z0-9]$`)
- `data.slugPrefix` (`string`)
- `data.authPassword` (`boolean`, required)
- `data.authGoogle` (`boolean`, required)
- `data.allowSelfSignup` (`boolean`, required)
- `data.accent` (`string | null`, required)
- `data.logoUrl` (`string | null`, required)
- `data.createdAt` (`string`, required)
- `data.assistantMonthlyCredits` (`integer | null`, required)
- `data.apps` (`integer`, required)
- `data.users` (`integer`, required)
- `data.assistantCreditsUsed` (`number`)
- `data.assistantCreditsLimit` (`number,null`)
- `data.assistantPresets` (`object[]`, required)
- `data.assistantPresets.label` (`string`, required, length: `1–24 chars`)
- `data.assistantPresets.model` (`string`, required, length: `1–120 chars`)
- `data.assistantPresets.reasoning` (`enum<string> | null`, required)
- `data.assistantPresetsEditable` (`boolean`)

```json
{
  "data": {
    "id": "<string>",
    "organizationId": "<string>",
    "name": "<string>",
    "slug": "<string>",
    "slugPrefix": "<string>",
    "authPassword": true,
    "authGoogle": true,
    "allowSelfSignup": true,
    "accent": "<string>",
    "logoUrl": "<string>",
    "createdAt": "<string>",
    "assistantMonthlyCredits": 123,
    "apps": 123,
    "users": 123,
    "assistantCreditsUsed": 123.45,
    "assistantCreditsLimit": null,
    "assistantPresets": [
      {
        "label": "<string>",
        "model": "<string>",
        "reasoning": "none"
      }
    ],
    "assistantPresetsEditable": true
  }
}
```

**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/suites/<suiteId>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "slug": "<string>",
  "authPassword": true,
  "authGoogle": true,
  "allowSelfSignup": true,
  "accent": "<string>",
  "logoUrl": "<string>",
  "assistantMonthlyCredits": 123,
  "assistantPresets": [
    {
      "label": "<string>",
      "model": "<string>",
      "reasoning": "none"
    }
  ]
}'
```