Publishing Pause

Pause or resume publishing

Pause or resume publishing for the whole workspace, or one brand with brand_id. Requires posts:write. pause needs publisher or higher; a seat limited to some brands can pause only those brands (403 brand_scoped_seat). Without confirm: true a pause changes nothing and answers 400 confirmation_required with a preview (scope, already_paused, scheduled_posts_to_hold); show it to the person and repeat with confirm: true once they agree. resume needs admin or higher and no confirm. It returns resumed_count, the missed_post_ids whose time passed while paused (they stay paused and never publish on their own; see /api/v1/publishing-pause/publish-missed), still_held_count, disconnected_count and failed_post_ids. Every pause and resume is logged like a dashboard click.

post/api/v1/publishing-pause

Request

  • Base URL: https://www.poster.ly
  • URL: https://www.poster.ly/api/v1/publishing-pause
  • Auth: HTTP bearer

Request body

action'pause' | 'resume' required
brand_idstring

A brand ID from /api/v1/brands. Leave it out (do not send it empty or null) for the whole workspace; an empty brand_id answers 400 empty_brand_id.

confirmboolean

pause: true only after the person agreed to the preview. resume: not needed.

workspace_idstring

Workspace ID from whoami.

Response

Publishing paused or resumed

okboolean
action'pause' | 'resume'
scope'workspace' | 'brand'
workspace_idstring
brand_idstring nullable
held_countinteger

pause: scheduled posts now held.

resumed_countinteger

resume: posts back on the schedule.

missed_countinteger
missed_post_idsinteger[]

resume: posts whose time passed while paused. They stay paused.

still_held_countinteger

resume: posts still held by the other switch.

disconnected_countinteger
failed_post_idsinteger[]
messagestring

Changes

No recorded changes to this operation across all 1 revision of this API.