Recurring posts

Pause a recurring post

Changed on

Stops creating occurrences and deletes the upcoming scheduled post. Requires the posts.draft permission.

post/recurring-posts/{id}/pause

Request

  • Base URL: https://post.adaptlypost.com/post/api/v1
  • URL: https://post.adaptlypost.com/post/api/v1/recurring-posts/{id}/pause
  • Auth: HTTP bearer

Path parameters

idstring required

Recurring post ID

Headers

X-Workspace-Idstring

The workspace to act in, for OAuth sign-ins that reach several workspaces. Take the id from GET /workspaces. Without it the call lands in the default workspace. A workspace the caller cannot reach answers 403 with code: workspace_access_denied. An API key belongs to one workspace: send its own id or leave the header out

Response

The paused recurring post

idstring
userIdstring
status'ACTIVE' | 'PAUSED' | 'ENDED'
pauseReason'USER' | 'CONSECUTIVE_FAILURES' | 'SUBSCRIPTION_INACTIVE' | 'ACCESS_LOST' | 'CONNECTION_REMOVED' | 'INVALID_CONTENT'
lastErrorstring
frequency'DAILY' | 'WEEKLY' | 'MONTHLY' | 'YEARLY'
intervalinteger
weekdaysstring[]
startsAtstring date-time
timezonestring
endsOnstring date-time
maxOccurrencesinteger
nextOccurrenceAtstring date-time

The next occurrence that does not exist as a post yet. Absent once the series has ended

occurrenceCountinteger

Posts created by the series so far

contentType'TEXT' | 'IMAGE' | 'VIDEO' | 'CAROUSEL' | 'DOCUMENT'

CAROUSEL takes 2 or more items in mediaUrls, up to 4 on TWITTER, BLUESKY and MASTODON, 5 on PINTEREST, 10 on INSTAGRAM, FACEBOOK and THREADS, 20 on LINKEDIN, 30 on TUMBLR and 35 on TIKTOK. A TIKTOK carousel takes JPEG or WebP photos only. INSTAGRAM and THREADS accept images and videos in the same carousel; every other platform takes images only, and YOUTUBE has no carousel. DOCUMENT publishes one PDF, PPT, PPTX, DOC or DOCX file (max 100 MB, 300 pages) as a LinkedIn document post, and is LinkedIn only: any other platform in the same request is rejected with a 400

textstring
mediaUrlsstring[]
mediaAltTextsstring[]
thumbnailUrlstring
thumbnailTimestampMsnumber

Video frame timestamp (ms) used as the thumbnail

platformTypesPlatformType[]
createdAtstring date-time
updatedAtstring date-time

Changes

  • 8390a5fa9a0dRevision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status