curl --request PATCH \
--url https://api.nohead.io/v1/fields/{field_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"key": "<string>",
"required": true,
"configuration": {
"description": "<string>",
"searchable": true,
"filterable": true,
"sortable": true,
"min_length": 1,
"max_length": 1,
"unique": true
}
}
'import { Nohead } from "@nohead/sdk"
const nohead = new Nohead()
const result = await nohead.fields.update("fld_01J9ZQ3F8X", { name: "Heading" })
from nohead import Nohead
nohead = Nohead()
result = nohead.fields.update("fld_01J9ZQ3F8X", name="Heading")
require "nohead"
nohead = Nohead::Client.new
result = nohead.fields.update("fld_01J9ZQ3F8X", name: "Heading")
{
"id": "fld_01J9ZQ3F8X5W2K7M4N6P0R1S2T",
"object": "field",
"collection_id": "<string>",
"name": "<string>",
"key": "<string>",
"required": true,
"multiple": true,
"position": 123,
"deleted_at": "2023-11-07T05:31:56Z",
"purge_after": "2023-11-07T05:31:56Z",
"aliases": [
{
"key": "<string>",
"expires_at": "2026-09-27T12:00:00.000Z"
}
],
"created_at": "2026-09-27T12:00:00.000Z",
"updated_at": "2026-09-27T12:00:00.000Z",
"type": "text",
"configuration": {
"description": "<string>",
"searchable": true,
"filterable": true,
"sortable": true,
"min_length": 1,
"max_length": 1,
"format": "slug",
"unique": true
}
}{
"error": {
"type": "invalid_request",
"message": "<string>",
"request_id": "req_01J9ZQ3F8X5W2K7M4N6P0R1S2T",
"details": [
{
"code": "<string>",
"message": "<string>",
"field": "<string>",
"usage": 123,
"limit": 123,
"current_revision": 123,
"record_id": "<string>",
"draft_id": "<string>"
}
]
}
}{
"error": {
"type": "invalid_request",
"message": "<string>",
"request_id": "req_01J9ZQ3F8X5W2K7M4N6P0R1S2T",
"details": [
{
"code": "<string>",
"message": "<string>",
"field": "<string>",
"usage": 123,
"limit": 123,
"current_revision": 123,
"record_id": "<string>",
"draft_id": "<string>"
}
]
}
}{
"error": {
"type": "invalid_request",
"message": "<string>",
"request_id": "req_01J9ZQ3F8X5W2K7M4N6P0R1S2T",
"details": [
{
"code": "<string>",
"message": "<string>",
"field": "<string>",
"usage": 123,
"limit": 123,
"current_revision": 123,
"record_id": "<string>",
"draft_id": "<string>"
}
]
}
}{
"error": {
"type": "invalid_request",
"message": "<string>",
"request_id": "req_01J9ZQ3F8X5W2K7M4N6P0R1S2T",
"details": [
{
"code": "<string>",
"message": "<string>",
"field": "<string>",
"usage": 123,
"limit": 123,
"current_revision": 123,
"record_id": "<string>",
"draft_id": "<string>"
}
]
}
}{
"error": {
"type": "invalid_request",
"message": "<string>",
"request_id": "req_01J9ZQ3F8X5W2K7M4N6P0R1S2T",
"details": [
{
"code": "<string>",
"message": "<string>",
"field": "<string>",
"usage": 123,
"limit": 123,
"current_revision": 123,
"record_id": "<string>",
"draft_id": "<string>"
}
]
}
}{
"error": {
"type": "validation_error",
"message": "Record validation failed",
"request_id": "req_01J9ZQ3F8X5W2K7M4N6P0R1S2T",
"details": [
{
"field": "title",
"code": "required",
"message": "is required"
}
]
}
}{
"error": {
"type": "invalid_request",
"message": "<string>",
"request_id": "req_01J9ZQ3F8X5W2K7M4N6P0R1S2T",
"details": [
{
"code": "<string>",
"message": "<string>",
"field": "<string>",
"usage": 123,
"limit": 123,
"current_revision": 123,
"record_id": "<string>",
"draft_id": "<string>"
}
]
}
}Update a field
Changes that keep existing record values valid. After a key
change the old key keeps working for 6 months as an alias (see
aliases), so clients have time to move. Changing type or multiple, or a
configuration that existing active records would violate, is rejected
with requires_migration: use POST /v1/collections/{collection_id}/migrations.
409 with detail code deleted while the field is deleted.
curl --request PATCH \
--url https://api.nohead.io/v1/fields/{field_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"key": "<string>",
"required": true,
"configuration": {
"description": "<string>",
"searchable": true,
"filterable": true,
"sortable": true,
"min_length": 1,
"max_length": 1,
"unique": true
}
}
'import { Nohead } from "@nohead/sdk"
const nohead = new Nohead()
const result = await nohead.fields.update("fld_01J9ZQ3F8X", { name: "Heading" })
from nohead import Nohead
nohead = Nohead()
result = nohead.fields.update("fld_01J9ZQ3F8X", name="Heading")
require "nohead"
nohead = Nohead::Client.new
result = nohead.fields.update("fld_01J9ZQ3F8X", name: "Heading")
{
"id": "fld_01J9ZQ3F8X5W2K7M4N6P0R1S2T",
"object": "field",
"collection_id": "<string>",
"name": "<string>",
"key": "<string>",
"required": true,
"multiple": true,
"position": 123,
"deleted_at": "2023-11-07T05:31:56Z",
"purge_after": "2023-11-07T05:31:56Z",
"aliases": [
{
"key": "<string>",
"expires_at": "2026-09-27T12:00:00.000Z"
}
],
"created_at": "2026-09-27T12:00:00.000Z",
"updated_at": "2026-09-27T12:00:00.000Z",
"type": "text",
"configuration": {
"description": "<string>",
"searchable": true,
"filterable": true,
"sortable": true,
"min_length": 1,
"max_length": 1,
"format": "slug",
"unique": true
}
}{
"error": {
"type": "invalid_request",
"message": "<string>",
"request_id": "req_01J9ZQ3F8X5W2K7M4N6P0R1S2T",
"details": [
{
"code": "<string>",
"message": "<string>",
"field": "<string>",
"usage": 123,
"limit": 123,
"current_revision": 123,
"record_id": "<string>",
"draft_id": "<string>"
}
]
}
}{
"error": {
"type": "invalid_request",
"message": "<string>",
"request_id": "req_01J9ZQ3F8X5W2K7M4N6P0R1S2T",
"details": [
{
"code": "<string>",
"message": "<string>",
"field": "<string>",
"usage": 123,
"limit": 123,
"current_revision": 123,
"record_id": "<string>",
"draft_id": "<string>"
}
]
}
}{
"error": {
"type": "invalid_request",
"message": "<string>",
"request_id": "req_01J9ZQ3F8X5W2K7M4N6P0R1S2T",
"details": [
{
"code": "<string>",
"message": "<string>",
"field": "<string>",
"usage": 123,
"limit": 123,
"current_revision": 123,
"record_id": "<string>",
"draft_id": "<string>"
}
]
}
}{
"error": {
"type": "invalid_request",
"message": "<string>",
"request_id": "req_01J9ZQ3F8X5W2K7M4N6P0R1S2T",
"details": [
{
"code": "<string>",
"message": "<string>",
"field": "<string>",
"usage": 123,
"limit": 123,
"current_revision": 123,
"record_id": "<string>",
"draft_id": "<string>"
}
]
}
}{
"error": {
"type": "invalid_request",
"message": "<string>",
"request_id": "req_01J9ZQ3F8X5W2K7M4N6P0R1S2T",
"details": [
{
"code": "<string>",
"message": "<string>",
"field": "<string>",
"usage": 123,
"limit": 123,
"current_revision": 123,
"record_id": "<string>",
"draft_id": "<string>"
}
]
}
}{
"error": {
"type": "validation_error",
"message": "Record validation failed",
"request_id": "req_01J9ZQ3F8X5W2K7M4N6P0R1S2T",
"details": [
{
"field": "title",
"code": "required",
"message": "is required"
}
]
}
}{
"error": {
"type": "invalid_request",
"message": "<string>",
"request_id": "req_01J9ZQ3F8X5W2K7M4N6P0R1S2T",
"details": [
{
"code": "<string>",
"message": "<string>",
"field": "<string>",
"usage": 123,
"limit": 123,
"current_revision": 123,
"record_id": "<string>",
"draft_id": "<string>"
}
]
}
}Authorizations
Project-scoped API key, e.g. nohead_sk_k7fz0a9c3m2q_<secret>, or
nohead_pk_… for a published-only key. Used by servers, CI, the CLI
and coding agents.
Headers
A unique value (1-255 printable ASCII characters) that makes retrying
this request safe. The first response (below 500) is stored for 24
hours per user or API key; retries with the same key and the same
request get it again with an Idempotent-Replayed: true header. The
same key with a different request is refused with 400; a retry while
the first request is still running gets 409.
1 - 255First-party client identifier recorded in history (e.g. cli/0.3.1). Informational only.
Optional reason for the change, kept with the record revision, schema
change or field migration it makes (at most 500 characters once
decoded). Percent-encoded UTF-8, as
encodeURIComponent encodes it, so any language fits in a header:
Rettet%20stavefejl%20p%C3%A5%20forsiden. Plain ASCII may be sent
as is. Other bytes are 400.
Path Parameters
Body
Renames, describes or loosens a field. A change to its type or multiple rewrites record values, so it is a field migration (POST /v1/collections/{collection_id}/migrations); either key here is 400 unknown_parameter, saying so.
The field's key in records' data, filters and sorts. Reserved for records' own attributes, and a few kept for later: id, object, collection, data, status, published_at, created_at, updated_at, deleted, deleted_at, purge_after, revision and schema_version.
Every record must have a value. Not available for boolean fields (a boolean is true or false; no value reads as false).
Type-specific options, e.g. max_length, options, target_collection_id,
accepted_types (asset fields: MIME types or type/* wildcards that newly
written values must have; any file when absent), include_time and
time_zone (date fields, below), format (text fields, below),
unique (text and integer fields, below), plus
the options for searches with API keys: searchable (the search words match the
field; default true for text, long_text, rich_text and enum), filterable and
sortable (default false).
Date fields hold a calendar date, YYYY-MM-DD, with no time and no
time zone: returned exactly as written, so it never shows as the day
before or after. With include_time: true they hold a moment: ISO
8601 with an offset, stored in UTC and returned in UTC, or with the
offset of time_zone (an IANA name such as Europe/Copenhagen,
daylight saving included) when the field has one. Input may use any
offset. Changing time_zone never rewrites values; turning
include_time on or off does, through a field migration.
Text fields (not long text) can have a format: slug
(lowercase letters, digits and single hyphens, at most 200
characters; one value per record, never a list, and always
unique: a slug field has unique: true), url (an absolute
http or https address) or email. A value that doesn't match is
refused with invalid_format. A format sets its own length limits
(254 characters for emails, 2,048 for URLs), so min_length and
max_length are for plain text. Text and integer
fields with one value can be unique: no two active records of the
collection share a value (emails compare ignoring capitals; records
without a value don't count). A taken value is refused with
taken and the record_id that has it. Turning unique on is
refused with duplicate_values while records share a value (and
so is restoring a deleted unique field, 409). A field migration
to a unique field is refused with duplicate_values when its
converted values or backfill would be shared, and fails if values
written while it waits would be.
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
Show child attributes
Show child attributes
Response
The updated field.
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
A field, typed by its type, which also decides the options its configuration takes.
Stable field ID. Never changes, even when the field is renamed.
"fld_01J9ZQ3F8X5W2K7M4N6P0R1S2T"
Display name. Safe to change.
Key used in record data. Part of the API contract.
Every record must have a value. Not available for boolean fields (a boolean is true or false; no value reads as false).
A list of distinct values (a repeated value is refused with duplicate_value, an empty string with blank_value). Not available for boolean, long_text, rich_text and json fields.
Where the field sorts in the collection's order, lowest first. New fields are added last; PUT /v1/collections/{collection_id}/field-order changes the order, numbering the fields from 0.
When the field was deleted; null unless it is. Its values stay hidden in records until it is restored or purged.
When a deleted field and its values are removed for good, unless restored first.
Old keys of a renamed field that still work until expires_at:
record data also carries the value under them, and writes, filters,
sorts and expand accept them. Responses about the collection then
have Deprecation and Sunset headers.
Show child attributes
Show child attributes
ISO 8601 timestamp in UTC.
"2026-09-27T12:00:00.000Z"
ISO 8601 timestamp in UTC.
"2026-09-27T12:00:00.000Z"
Plain text up to 10,000 characters, or a format.
Show child attributes
Show child attributes