BioFlow / API docs / publishPage

Publish a page.

POST /v1/pages/{page_id}/publish
scope: publishCreator & Pro plansquota cost: 1send an Idempotency-Key

Publish 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.

Try it

Request.

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" }'
Parameters

Path & query parameters.

Parameters accepted by publishPage
NameInTypeRequiredDescription
page_idpathstringyesPage ID from List pages
Request body

JSON body (application/json).

Request-body fields for publishPage
FieldTypeRequiredDescription
starts_atstring (ISO 8601)noOmit to publish now; an ISO instant schedules the publish instead
Response

200The published (or scheduled) page.

Fields of the 200 response for publishPage
FieldTypeDescription
pageobject
scheduled_forstring (ISO 8601) | nullSet when the publish was scheduled, not applied

Every response also carries X-Request-Id plus the IETF draft-11 RateLimit / RateLimit-Policy headers.

Errors

What can go wrong here.

Problem codes this operation can return
CodeStatusMeaning
invalid_request400The request body or parameters failed validation
invalid_api_key401Missing, malformed, unknown, disabled, or expired API key
insufficient_scope403The API key was not granted the required scope
feature_not_enabled403The workspace plan does not include public API access
test_key_read_only403Test-mode keys are restricted to read operations
rate_limited429Per-key rate limit exceeded
quota_exhausted429Monthly API quota exhausted
internal_error500Something 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.