Manage Scheduled Posts
Schedule your uploads in advance and keep full control over them with our job management endpoints. This page covers how to list and cancel scheduled jobs created via the scheduled_date
parameter.
List Scheduled Posts
Endpoint | GET /api/uploadposts/schedule |
Authentication | Required. Supply the Apikey in the Authorization header — e.g. Authorization: Apikey <token> |
Query / Body Params | None. The user is inferred from the access-token. |
Success Response 200 OK
Returns a JSON array where each element is a scheduled-job object:
[
{
"job_id": "a1b2c3d4e5f67890a1b2c3d4e5f67890",
"scheduled_date": "2024-12-25T10:30:00Z",
"post_type": "video",
"profile_username": "my_upload_post_profile",
"title": "Merry Christmas!",
"preview_url": "https://storage.googleapis.com/signed-url/video_preview.mp4?signature=..."
}
]
Field | Type | Description |
---|---|---|
job_id | string | Unique identifier of the scheduled job. Required to cancel it. |
scheduled_date | string | ISO-8601 date/time when the post will go live. Time is in UTC. |
post_type | string | One of video , photo , or text . |
profile_username | string | Upload-Post profile that will publish the content. |
title | string | Title/caption of the post. |
preview_url | string | null | Short-lived signed URL to preview the media (first photo or video). null for text posts. |
Error Responses
Status | Reason |
---|---|
401 Unauthorized | Missing or invalid token. |
Cancel a Scheduled Post
Endpoint | DELETE /api/uploadposts/schedule/<job_id> |
Authentication | Required. Same Authorization header as above. |
URL Param | job_id — ID obtained from the list endpoint. |
Success Response 200 OK
{
"success": true,
"message": "Job <job_id> cancelled and assets deleted."
}
Error Responses
Status | Body | Condition |
---|---|---|
401 Unauthorized | Invalid or missing token. | |
404 Not Found | { "success": false, "error": "Job not found" } | The supplied job_id does not exist or doesn't belong to the authenticated user. |
500 Internal Server Error | Unexpected failure while cancelling the job or deleting its assets. |
Edit a Scheduled Post
Endpoint | PATCH /api/uploadposts/schedule/<job_id> |
Authentication | Required. Same Authorization header as above. |
URL Param | job_id — ID obtained from the list endpoint. |
Body | JSON object with one or more of the fields below. |
Field | Type | Required | Description |
---|---|---|---|
scheduled_date | string | No | ISO-8601 date/time in UTC (suffix Z allowed). Must be in the future and within 1 year. |
title | string | No | New post title/caption. |
caption | string | No | New caption/description. |
Success Response 200 OK
{
"success": true,
"job_id": "a1b2c3d4e5f67890a1b2c3d4e5f67890",
"scheduled_date": "2025-10-05T10:30:00Z",
"title": "Updated title",
"caption": "Updated caption"
}
Error Responses
Status | Body | Condition |
---|---|---|
400 Bad Request | { "success": false, "error": "<reason>" } | Invalid body; invalid/past date; job not editable; daily limit reached. |
401 Unauthorized | Invalid or missing token. | |
403 Forbidden | { "success": false, "error": "Forbidden" } | The job does not belong to the authenticated user. |
404 Not Found | { "success": false, "error": "Job not found" } | The supplied job_id does not exist. |
500 Internal Server Error | Unexpected failure while editing the job. |
Example Request
curl -X PATCH "https://api.upload-post.com/api/uploadposts/schedule/JOB_ID" \
-H "Content-Type: application/json" \
-H "Authorization: Apikey <token>" \
-d '{
"scheduled_date": "2025-10-05T10:30:00Z",
"title": "Updated title",
"caption": "Updated caption"
}'
See Also
- Using
scheduled_date
when uploading content – parameter description. - Upload Video, Upload Photos, Upload Text – endpoints that support scheduling.