BioFlow / API docs / publishPage
POST /v1/pages/{page_id}/publishPublish the page's current DRAFT to its live public route — the same code path as the editor's Publish button. Pass starts_at to schedule the publish instead of applying it now. Requires the publish scope, granted separately at key creation.
Requires scope: publish. Plan entitlement: public_api (Creator and Pro).
Consequential operation — send an Idempotency-Key header.
curl "https://app.getbioflow.com/v1/pages/PAGE_ID/publish" \
-X POST \
-H "Authorization: Bearer bf_live_YOUR_KEY" \
-H "Idempotency-Key: a-unique-id-per-attempt" \
-H "Content-Type: application/json" \
-d '{
"starts_at": "2026-08-01T12:00:00.000Z"
}'| Name | In | Type | Required | Description |
|---|---|---|---|---|
page_id | path | string | yes | Page ID from List pages |
| Field | Type | Required | Description |
|---|---|---|---|
starts_at | string (ISO 8601) | no | Omit to publish now; an ISO instant schedules the publish instead |
| Field | Type | Description |
|---|---|---|
page | object | — |
scheduled_for | string (ISO 8601) | null | Set when the publish was scheduled, not applied |
Every response also carries X-Request-Id plus the IETF draft-11 RateLimit / RateLimit-Policy headers.
| Code | Status | Meaning |
|---|---|---|
invalid_request | 400 | The request body or parameters failed validation |
invalid_api_key | 401 | Missing, malformed, unknown, disabled, or expired API key |
insufficient_scope | 403 | The API key was not granted the required scope |
feature_not_enabled | 403 | The workspace plan does not include public API access |
test_key_read_only | 403 | Test-mode keys are restricted to read operations |
rate_limited | 429 | Per-key rate limit exceeded |
quota_exhausted | 429 | Monthly API quota exhausted |
internal_error | 500 | Something went wrong on our side |
All errors are RFC 9457 application/problem+json — branch on code, quote request_id to support. Full registry on the API docs hub; interactive playground in the API reference.