curl --request PATCH \
--url https://api.nohead.io/v1/collections/{collection_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"public_search": true
}
'import { Nohead } from "@nohead/sdk"
const nohead = new Nohead()
const result = await nohead.collections.update("posts", { name: "Articles" })
from nohead import Nohead
nohead = Nohead()
result = nohead.collections.update("posts", name="Articles")
require "nohead"
nohead = Nohead::Client.new
result = nohead.collections.update("posts", name: "Articles")
{
"id": "col_01J9ZQ3F8X5W2K7M4N6P0R1S2T",
"object": "collection",
"project_id": "<string>",
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"schema_version": 123,
"deleted_at": "2023-11-07T05:31:56Z",
"purge_after": "2023-11-07T05:31:56Z",
"public_search": true,
"fields": [
{
"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
}
}
],
"created_at": "2026-09-27T12:00:00.000Z",
"updated_at": "2026-09-27T12:00:00.000Z"
}{
"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 collection
Changing the slug breaks clients that address the collection by slug.
409 with detail code deleted while the collection is deleted.
curl --request PATCH \
--url https://api.nohead.io/v1/collections/{collection_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"public_search": true
}
'import { Nohead } from "@nohead/sdk"
const nohead = new Nohead()
const result = await nohead.collections.update("posts", { name: "Articles" })
from nohead import Nohead
nohead = Nohead()
result = nohead.collections.update("posts", name="Articles")
require "nohead"
nohead = Nohead::Client.new
result = nohead.collections.update("posts", name: "Articles")
{
"id": "col_01J9ZQ3F8X5W2K7M4N6P0R1S2T",
"object": "collection",
"project_id": "<string>",
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"schema_version": 123,
"deleted_at": "2023-11-07T05:31:56Z",
"purge_after": "2023-11-07T05:31:56Z",
"public_search": true,
"fields": [
{
"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
}
}
],
"created_at": "2026-09-27T12:00:00.000Z",
"updated_at": "2026-09-27T12:00:00.000Z"
}{
"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
Collection ID, or the collection slug when authenticating with an API key.
Response
The updated collection.
"col_01J9ZQ3F8X5W2K7M4N6P0R1S2T"
When the collection was deleted; null unless it is.
When a deleted collection is removed for good, with its fields and records, unless restored first.
Whether the project's search tokens (made in the web app) find its published records, from a browser or a backend. Off by default: every field of those records becomes readable by anyone with a token, so turn it on only for collections whose published records are public. A change reaches search tokens within seconds.
Active fields in position order.
A field, typed by its type, which also decides the options its configuration takes.
- 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
ISO 8601 timestamp in UTC.
"2026-09-27T12:00:00.000Z"
ISO 8601 timestamp in UTC.
"2026-09-27T12:00:00.000Z"