{
"id": "7f1c0f7e-3c5e-4b1a-9d34-2f0a5b6c8d90",
"title": "Pricing deck",
"kind": "pdf",
"status": "live",
"url": "https://docurise.io/v/pricing-deck",
"createdAt": "2026-09-30T12:00:00.000Z",
"updatedAt": "2026-10-01T08:30:00.000Z",
"expiresAt": "2026-12-31T00:00:00.000Z",
"description": "Q4 pricing",
"expiry": {
"type": "fixed_date",
"expiresAt": "2026-12-31T00:00:00.000Z",
"days": null
},
"protection": {
"accessMode": "public",
"requireEmail": true,
"requireEmailVerification": false,
"passwordProtected": false,
"allowedEmails": [],
"allowedDomains": []
},
"revision": "2026-10-01T08:30:00.000Z"
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"retryAfterSeconds": 123,
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"retryAfterSeconds": 123,
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"retryAfterSeconds": 123,
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"retryAfterSeconds": 123,
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"retryAfterSeconds": 123,
"details": {}
}
}{
"error": {
"code": "PROTECTION_RULE_CONFLICT",
"message": "requireEmail cannot be false: a form always collects the visitor email, so it cannot be turned off",
"retryable": false,
"details": {
"rule": "form"
}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"retryAfterSeconds": 123,
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"retryAfterSeconds": 123,
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"retryAfterSeconds": 123,
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"retryAfterSeconds": 123,
"details": {}
}
}Update a document
Publish a draft post or form, pause or resume a document, set or clear its expiry, and change its email protection, guarded by the document revision in the request body, copied from the revision or ETag that GET returns
{
"id": "7f1c0f7e-3c5e-4b1a-9d34-2f0a5b6c8d90",
"title": "Pricing deck",
"kind": "pdf",
"status": "live",
"url": "https://docurise.io/v/pricing-deck",
"createdAt": "2026-09-30T12:00:00.000Z",
"updatedAt": "2026-10-01T08:30:00.000Z",
"expiresAt": "2026-12-31T00:00:00.000Z",
"description": "Q4 pricing",
"expiry": {
"type": "fixed_date",
"expiresAt": "2026-12-31T00:00:00.000Z",
"days": null
},
"protection": {
"accessMode": "public",
"requireEmail": true,
"requireEmailVerification": false,
"passwordProtected": false,
"allowedEmails": [],
"allowedDomains": []
},
"revision": "2026-10-01T08:30:00.000Z"
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"retryAfterSeconds": 123,
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"retryAfterSeconds": 123,
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"retryAfterSeconds": 123,
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"retryAfterSeconds": 123,
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"retryAfterSeconds": 123,
"details": {}
}
}{
"error": {
"code": "PROTECTION_RULE_CONFLICT",
"message": "requireEmail cannot be false: a form always collects the visitor email, so it cannot be turned off",
"retryable": false,
"details": {
"rule": "form"
}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"retryAfterSeconds": 123,
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"retryAfterSeconds": 123,
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"retryAfterSeconds": 123,
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"retryAfterSeconds": 123,
"details": {}
}
}Authorizations
A key generated from Settings → Developers, sent as
Authorization: Bearer dr_live_<12 hex chars>_<64 hex chars>. Keys
carry explicit scopes — each endpoint states the one it requires.
The full key is shown exactly once at generation time and cannot be
retrieved again; only the keyId prefix is shown afterward. A
revoked key fails auth on its very next request.
Path Parameters
The document id.
Body
revision is required, and at least one other field. Any unknown field is rejected with 400 VALIDATION_ERROR.
The revision of the document as last returned by GET or PATCH (the plain timestamp is the form to send; the ETag header value is accepted too, as the quoted "..." or the weak W/"..." form). A stale value is 409 REVISION_CONFLICT. Send it here, not as If-Match.
"2026-10-04T01:02:03.456Z"
live on a draft post or form publishes it, with the publishing checks; a published post or form cannot go back to draft. live and inactive pause and resume a published document. See the table on the operation for what each value does per document kind.
live, draft, inactive RFC 3339 with Z or a numeric offset, stored as UTC. null removes the expiry. Omit it to leave the expiry alone.
"2026-12-31T23:59:59+09:00"
true asks visitors for an email, false stops asking. false is refused with 422 PROTECTION_RULE_CONFLICT for a form, a document with specific access, and a document with a lead gate. Turning it on ends the sessions visitors already unlocked.
true makes visitors confirm their email through a link. Turning it on ends the sessions visitors already unlocked. Refused for a form (422 PROTECTION_RULE_CONFLICT).
The full list of allowed email addresses (it replaces the stored list). Lowercased and de-duplicated. [] empties it. Enforced only when the access mode is specific. A non-empty list is refused for a form.
10000["alice@example.com"]
The full list of allowed bare domains such as acme.com (it replaces the stored list). Lowercased and de-duplicated; exact match, subdomains are not included. [] empties it. Enforced only when the access mode is specific. A non-empty list is refused for a form.
10000["acme.com"]
Response
The document after the change.
A DocumentSummary plus description, expiry, a protection summary with the two allow lists, and the
revision. status is the one visitors get (the same value as in the list, including expired).
This is also the body a successful PATCH /api/preview/documents/{id} returns.
The document's id.
The document's title.
What the document is made of: notion, pdf, upload (a file you uploaded), post or form.
notion, pdf, upload, post, form The status: live (visitors can open it), draft (a post or form that is not published yet), inactive (turned off, by you or automatically, for example when a Notion page can no longer be read) or expired (its expiry date has passed).
live, draft, inactive, expired The public share link.
When the document was created (RFC 3339, UTC).
When the document was last changed (RFC 3339, UTC).
The fixed expiry date, or null when there is none. A per-viewer (relative) expiry has no single date, so it is null here; see expiry on the single-document response.
The document's subtitle, or null when none is set.
When the document expires.
Show child attributes
Show child attributes
How the document is gated. Change the email and allow-list fields with PATCH; the password and the access mode are read-only here. Never contains the password.
Show child attributes
Show child attributes
Identifies this version of the settings (an ISO 8601 UTC timestamp, milliseconds). Also sent as the ETag header; send it back as revision in the body of PATCH. Treat it as opaque.