Skip to content

Schedule Blog Post​

POST
/api/v1/posts/{id}/schedule

Authorizations​

SessionAuth

Session ID for authenticated requests

Type
API Key (header: X-Session-ID)

Parameters​

Path Parameters

id*
Type
string
Required

Request Body​

application/json
JSON
{
  
"scheduled_at": "string"
}

Responses​

Post scheduled

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​

Powered by VitePress OpenAPI

Schedule a blog post for later publishing.

Auth: session + owner/admin.

Parameters ​

NameInTypeRequiredDescription
idpathstringYesPost id

Request Body ​

json
{
	"scheduled_at": "2026-04-05T10:00:00.000Z"
}

Response 200 ​

json
{
	"data": { "id": "post_2", "status": "scheduled", "scheduled_at": "2026-04-05T10:00:00.000Z" },
	"user_context": { "authenticated": true },
	"meta": {}
}

Response Errors ​

  • 400 invalid schedule payload
  • 401 missing session
  • 403 not owner/admin
  • 404 post not found
  • 429 RATE_LIMIT_EXCEEDED

Notes ​

  • Rate limit: post bucket, 10 requests / 3600s by default. A session that can publish (admin, superadmin, author, editor, or the roles in BLOG_ALLOWED_POST_ROLES and BLOG_ADMIN_ROLES) is not counted. Otherwise 429 RATE_LIMIT_EXCEEDED. See Rate limits.

  • Use this for timed editorial publishing.

  • The post remains hidden until the scheduled publish moment.