---
title: "Change a field's name, type, width or options"
description: "Update a field; its `id` is its column and never changes."
canonical: "https://grid82.com/docs/builder-api/fields/update"
updated: "2026-11-13"
---

# Change a field's name, type, width or options

`PATCH https://studio.grid82.app/v1/apps/{appId}/tables/{tableId}/fields/{fieldId}`

Update a field; its `id` is its column and never changes.

Merge `config` with existing settings and validate against the resulting type. Type changes convert values in one transaction: keep values readable as the new type, clear others. Explain effects on pages, view filters and permission conditions before proposing a type change. Cannot convert to or from a relation; add a new field and delete the old one. Select options replace the whole list: keep each option's `id` to preserve its rows. Removed options are cleared from all records in the same transaction; single choices become empty, multiselects keep other choices. Restore cleared values with `trash.restore`.

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

## Path parameters

| Name      | Type   | Required | Description |
| --------- | ------ | -------- | ----------- |
| `appId`   | string | yes      |             |
| `tableId` | string | yes      |             |
| `fieldId` | string | yes      |             |

## Query parameters

| Name          | Type    | Required | Description |
| ------------- | ------- | -------- | ----------- |
| `acknowledge` | boolean | no       |             |

## 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.      |
| `type`   | "text" or "longtext" or "email" or "url" or "phone" or "json" or "number" or "currency" or "percent" or "rating" or "duration" or "select" or "multiselect" or "checkbox" or "user" or "attachment" or "date" or "recordId" or "autonumber" or "createdTime" or "createdBy" or "modifiedTime" or "modifiedBy" or "link" or "lookup" or "rollup" or "formula" or "button" | no       |                           |
| `width`  | integer                                                                                                                                                                                                                                                                                                                                                                  | no       | At least 60. At most 900. |
| `config` | object                                                                                                                                                                                                                                                                                                                                                                   | 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.width` (`integer`, range: `60–900`)
- `data.type` (`string`, required)
- `data.config` (`object`, required, default: `{}`)

```json
{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "width": 123,
    "type": "<string>",
    "config": {}
  }
}
```

**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>/tables/<tableId>/fields/<fieldId>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "type": "text",
  "width": 123,
  "config": {}
}'
```
