Update a field

Change a draft field: label, description, required, unique, config, status (active/deprecated) or type. A type change is a conversion applied at publish; preview it with records.fields.convert_preview.

Authorization

bearerApiKey

AuthorizationBearer <token>

Create a scoped API key in the Adlass settings.

In: header

Path Parameters

record_type_id*string

Resource identifier: record_type_id.

Formatuuid

record_field_id*string

Resource identifier: record_field_id.

Formatuuid

Header Parameters

X-Request-Id?string

Optional correlation identifier.

Lengthlength <= 128

Idempotency-Key*string

A unique key for this intended write. Reuse it only for an identical retry.

Length1 <= length <= 200

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

expected_draft_revision?integer

Range1 <= value

key?string

Machine key: a lowercase letter followed by lowercase letters, digits or underscores. Field keys cannot use the system column names archived_at, created_at, created_by, id, revision, title, updated_at, updated_by.

Match^[a-z][a-z0-9_]{0,63}$

Lengthlength <= 64

label?string

Lengthlength <= 120

description?string

Lengthlength <= 500

required?boolean

unique?boolean

config?

Type-specific configuration. text: format. number: precision. money: currency_default, precision. single_select and multi_select: options. lookup: relationship_id and lookup_field_id. count: relationship_id. Values in rows by field type: text and long_text: a string. number: a decimal string such as "12.50" (plain numbers are accepted). money: {"amount": "12.50", "currency": "COP"}, never a bare number; amount is a decimal string, currency an ISO 4217 code that falls back to currency_default. boolean: true or false. date: "YYYY-MM-DD". datetime: ISO 8601, stored in UTC. single_select: one option key. multi_select: a list of option keys. lookup and count: read-only. record_relation: record ids in relations {field_key: [record ids]}, replacing the full list. document_relation: document ids in documents {field_key: [document ids]}, replacing the full list.

type?string

Value in

"text"
"long_text"
"number"
"money"
"boolean"
"date"
"datetime"
"single_select"
"multi_select"
"record_relation"
"document_relation"
"lookup"
"count"

status?string

Value in

"active"
"deprecated"

include_type?boolean

Return the full record type detail (all draft fields, relationships, published schema) instead of {field or fields, draft_revision, field_count}.

Defaultfalse

Response Body

`application/json`

`application/problem+json`

curl -X PATCH "https://example.com/records/types/123e4567-e89b-42d3-a456-426614174000/fields/123e4567-e89b-42d3-a456-426614174000" \  -H "Idempotency-Key: 123e4567-e89b-42d3-a456-426614174000" \  -H "Content-Type: application/json" \  -d '{}'

{}

Authorization

Path Parameters

Header Parameters

Request Body

Response Body

200application/json

400application/problem+json

401application/problem+json

402application/problem+json

403application/problem+json

404application/problem+json

405application/problem+json

409application/problem+json

410application/problem+json

413application/problem+json

415application/problem+json

422application/problem+json

429application/problem+json

500application/problem+json

502application/problem+json

503application/problem+json

504application/problem+json

`application/json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`