/Docs
Search docs or ask a question⌘K
DocsAgent
Changelog
API Reference Update Scheduled Publish

Update Scheduled Publish

Change the time, content or commit message of a pending scheduled publish.

PATCH/v1/projects/{projectId}/schedules/{scheduleId}Try it
Session token

Reschedule a pending publish, or replace its content or commit message. Only schedules still in the scheduled state can be edited.

Note

Requires the schedule's creator, or the admin or owner role, signed in with a session JWT — API keys are refused with 401. Anyone else in the workspace gets 403 forbidden with details.currentRole. You must belong to the organization that owns {projectId}. Available on every plan.

Note

Due schedules are published within about a minute of their time: the content is committed (or saved, for a project written in Syntext) and a build starts. While it runs the row is publishing; it then moves to published with commitSha, or to failed with errorMessage.

Path Parameters

NameDescription
projectId:stringpathRequired
The project ID.
scheduleId:stringpathRequired
The schedule ID. A schedule that belongs to another project returns 404.

Request Body

Send at least one field.

NameDescription
scheduledFor:stringbody
New go-live time, as an ISO 8601 datetime (e.g. 2026-11-17T09:00:00Z). Must be in the future.
content:stringbody
Replacement content for the page. Cannot be empty.
commitMessage:string | nullbody
Up to 500 characters. null clears it.

Response — 200 OK

The full schedule:

Error Responses

400 Bad Request

invalid_schedule — scheduledFor is not in the future. details.scheduledFor echoes the time you sent.

json
{
"error": {
"code": "invalid_schedule",
"message": "Pick a time in the future.",
"details": {
"scheduledFor": "2026-11-01T09:00:00.000Z",
"traceId": "6f1c2a9e-3b7d-4c11-9a0e-2d5f8b4c7e10"
}
}
}

An empty body, an invalid datetime, empty content or a commitMessage over 500 characters fails schema validation. It returns 400 validation_error, with each problem in details.issues.

401 Unauthorized

No session JWT, an expired one, or an API key.

403 Forbidden

forbidden — you did not create this schedule and are not an admin or owner (details.currentRole), or you are not a member of the organization that owns the project.

404 Not Found

not_found — the project does not exist or was deleted, or the schedule is not one of this project's.

409 Conflict

not_scheduled — the schedule has already published, failed or been cancelled. details.status says which. The same code, without details.status, is returned when the schedule changed state while your edit was being applied.

Was this page helpful? Yes No
Request
cURLJavaScriptPythonGoRubyPHPJavaC#cURL
curl -X PATCH https://api.syntext.dev/v1/projects/3f2a9c1e-8b4d-4e7a-9c21-5d6e7f8a9b0c/schedules/3b9d6c1e-2a4f-4d8b-9e0a-1c2b3d4e5f60 \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..." \
-H "Content-Type: application/json" \
-d '{
"scheduledFor": "2026-11-17T09:00:00Z",
"commitMessage": "docs: launch webhooks v2"
}'
Responseapplication/json
200OK
{
"data": {
"id": "3b9d6c1e-2a4f-4d8b-9e0a-1c2b3d4e5f60",
"projectId": "3f2a9c1e-8b4d-4e7a-9c21-5d6e7f8a9b0c",
"pagePath": "guides/webhooks",
"content": "---\ntitle: Webhooks\n---\n\n# Webhooks\n...",
"commitMessage": "docs: launch webhooks v2",
"scheduledFor": "2026-11-17T09:00:00.000Z",
"publishedAt": null,
"cancelledAt": null,
"createdBy": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
"status": "scheduled",
"errorMessage": null,
"commitSha": null,
"createdAt": "2026-11-08T10:02:00.000Z"
}
}
Product
Resources
Company
© 2026 SyntextBuilt with Syntext