Skip to main content
PATCH
Update a field

Authorizations

Authorization
string
header
required

Cactal API key. Create one in the dashboard or via POST /apiKeys. The plaintext key is shown once at creation.

Path Parameters

fieldId
string
required
Minimum string length: 1

Body

application/json
displayName
string
Required string length: 1 - 200
description
string | null
Maximum string length: 2000
required
boolean
isUnique
boolean
example
any
config
object
key
string

New key for the field — a rename. Omit to keep the current key. Atomically migrates the key in every stored item’s data, so no values are lost.

Pattern: ^[a-z][a-z0-9_]{0,63}$
position
enum<string>

Moves the field within the collection’s display order. Omit to leave the order unchanged. "before" / "after" require anchorFieldId.

Available options:
before,
after,
first,
last
anchorFieldId
string

Sibling field to move against when position is "before" or "after".

Minimum string length: 1

Response

The updated field.

id
string
required

Unique field id.

collectionId
string
required

Id of the owning collection.

key
string
required

JSON key under item data. Lowercase snake_case, max 64 characters, unique per collection. Changed only via key on the update-field endpoint, which migrates stored data.

displayName
string
required

Human-readable name, 1–200 characters.

description
string | null
required

Optional description, up to 2,000 characters.

type
enum<string>
required

Value type. Immutable after creation.

Available options:
plain_text,
markdown,
number,
boolean,
date,
link,
email,
color,
option,
reference,
multi_reference,
image,
gallery,
file
required
boolean
required

Whether every item must carry a non-null value for this field. Enforced on write.

isUnique
boolean
required

Whether values must be unique across the collection’s active items. Not supported for plain_text, markdown, multi_reference, image, gallery, or file fields.

position
string
required

Fractional ordering key; fields sort lexicographically by this value.

example
any
required

Optional example value used as a design-phase placeholder. Any JSON value; null when unset.

config
object | null
required

Type-specific configuration. Present for option fields only; null for all other types.

targetCollectionId
string | null
required

For reference and multi_reference fields, the id of the collection referenced items must belong to (same website). null otherwise. Immutable.