Skip to main content

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​

EndpointGET /api/uploadposts/schedule
AuthenticationRequired. Supply the Apikey in the Authorization header — e.g. Authorization: Apikey <token>
Query / Body ParamsNone. 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=..."
  }
]
FieldTypeDescription
job_idstringUnique identifier of the scheduled job. Required to cancel it.
scheduled_datestringISO-8601 date/time when the post will go live.
post_typestringOne of video, photo, or text.
profile_usernamestringUpload-Post profile that will publish the content.
titlestringTitle/caption of the post.
preview_urlstring | nullShort-lived signed URL to preview the media (first photo or video). null for text posts.

Error Responses​

StatusReason
401 UnauthorizedMissing or invalid token.

Cancel a Scheduled Post​

EndpointDELETE /api/uploadposts/schedule/<job_id>
AuthenticationRequired. Same Authorization header as above.
URL Paramjob_id — ID obtained from the list endpoint.

Success Response 200 OK​

{
  "success": true,
  "message": "Job <job_id> cancelled and assets deleted."
}

Error Responses​

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

See Also​