cURL

curl --request PUT \
  --url https://api.nohead.io/v1/drafts/{draft_id}/schedule \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "merge_at": "2026-09-27T12:00:00.000Z"
}
'

{
  "id": "drf_01J9ZQ3F8X5W2K7M4N6P0R1S2T",
  "object": "draft",
  "record_id": "<string>",
  "collection_id": "<string>",
  "collection": "<string>",
  "base_revision": 123,
  "revision": 123,
  "data": {
    "title": "Introducing Foo",
    "body": {
      "type": "doc",
      "content": []
    }
  },
  "changed_fields": [
    "<string>"
  ],
  "schedule": {
    "merge_at": "2023-11-07T05:31:56Z",
    "last_error": "<string>"
  },
  "created_by": {
    "type": "user",
    "id": "<string>",
    "name": "<string>"
  },
  "edited_by": [
    {
      "type": "user",
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "created_at": "2026-09-27T12:00:00.000Z",
  "updated_at": "2026-09-27T12:00:00.000Z",
  "expanded": {}
}

{
  "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>"
      }
    ]
  }
}

Drafts

Schedule a draft's merge

Merges the draft at merge_at, a future time (records:write), within a minute of it, from the scheduler (via: scheduler). The merge uses the draft as it is then. One that can’t be made leaves the draft as it is, with schedule.last_error (and draft.schedule_failed), as does one due while the collection is deleted; one due while a field migration runs on the collection is made once the migration finishes. Returns the draft. A merge due while the record is deleted waits; once its time has passed, restoring the record drops it, with last_error. Setting the time the draft already has changes nothing and records no event.

PUT

drafts

{draft_id}

schedule

cURL

curl --request PUT \
  --url https://api.nohead.io/v1/drafts/{draft_id}/schedule \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "merge_at": "2026-09-27T12:00:00.000Z"
}
'

{
  "id": "drf_01J9ZQ3F8X5W2K7M4N6P0R1S2T",
  "object": "draft",
  "record_id": "<string>",
  "collection_id": "<string>",
  "collection": "<string>",
  "base_revision": 123,
  "revision": 123,
  "data": {
    "title": "Introducing Foo",
    "body": {
      "type": "doc",
      "content": []
    }
  },
  "changed_fields": [
    "<string>"
  ],
  "schedule": {
    "merge_at": "2023-11-07T05:31:56Z",
    "last_error": "<string>"
  },
  "created_by": {
    "type": "user",
    "id": "<string>",
    "name": "<string>"
  },
  "edited_by": [
    {
      "type": "user",
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "created_at": "2026-09-27T12:00:00.000Z",
  "updated_at": "2026-09-27T12:00:00.000Z",
  "expanded": {}
}

{
  "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

Authorization

string

header

required

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

Idempotency-Key

string

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.

Required string length: 1 - 255

Nohead-Client

string

First-party client identifier recorded in history (e.g. cli/0.3.1). Informational only.

Path Parameters

draft_id

string

required

Query Parameters

rich_text

enum<string>

default:document

How rich text fields read in the records and drafts returned (and in records they embed with expand): document, the stored ProseMirror JSON document; html, an HTML fragment of known elements with every text and attribute escaped, to put in a page as it is; or markdown (GitHub Flavored), which reads back as the same document when written. Images render with their URLs, so they need no expand: in HTML a WebP rendition at most 1600 pixels wide with its width and height (an SVG as itself), in Markdown the asset's image_url. An image whose asset was deleted is left out of HTML, and written as its asset ID in Markdown. Record history keeps documents.

Available options:

document,

html,

markdown

Body

application/json

merge_at

string<date-time>

required

ISO 8601 timestamp in UTC.

Example:

"2026-09-27T12:00:00.000Z"

Response

The draft.

Changes to a record's content that wait until they are merged into it, now or at schedule.merge_at. Content only: whether the record is live is its publication and schedule.

string

required

Example:

"drf_01J9ZQ3F8X5W2K7M4N6P0R1S2T"

object

any

required

record_id

string

required

collection_id

string

required

collection

string

required

The collection slug.

base_revision

integer

required

The record's revision when the draft started. Fields the record changed since keep their values at the merge, unless the draft changes them too; compare with GET /v1/records/{id}/diff?from=<base_revision>.

revision

integer

required

The draft's own revision, 1 when started and one more per change; also returned as the ETag.

data

object

required

The record's values as they read after the merge.

Example:

{
  "title": "Introducing Foo",
  "body": { "type": "doc", "content": [] }
}

changed_fields

string[]

required

Keys of the fields the draft changes.

schedule

object

required

When the draft merges on its own (within a minute of the time), set with PUT /v1/drafts/{draft_id}/schedule. last_error explains the last scheduled merge that could not be made, until a new one is set.

Show child attributes

created_by

object

required

Show child attributes

edited_by

object[]

required

Everyone who changed it since, in order.

Show child attributes

created_at

string<date-time>

required

ISO 8601 timestamp in UTC.

Example:

"2026-09-27T12:00:00.000Z"

updated_at

string<date-time>

required

ISO 8601 timestamp in UTC.

Example:

"2026-09-27T12:00:00.000Z"

expanded

object

Only with expand, as on a record, for the values after the merge.

Show child attributes