Posts

Delete a group of draft/scheduled posts

Delete all draft/scheduled/failed/paused posts that match a caller-defined group_id, post_group_id, api_group_id, or release_id metadata value. Published, publishing, and processing posts block the deletion and are returned in the 409 response.

delete/api/v1/posts/group/{group}

Request

  • Base URL: https://www.poster.ly
  • URL: https://www.poster.ly/api/v1/posts/group/{group}
  • Auth: HTTP bearer

Path parameters

groupstring required

Caller-defined post group ID stored as api_group_id, post_group_id, group_id, or release_id metadata

Request body

confirmboolean required

Must be true to delete all deletable posts in the group.

Example request

{
  "confirm": true
}

Response

Group posts deleted successfully

deletedboolean required
group_idstring required
deleted_post_idsinteger[] required
deleted_countinteger required
removed_queued_jobsinteger

Example response

{
  "deleted": true,
  "group_id": "campaign-42",
  "deleted_post_ids": [
    971,
    972
  ],
  "deleted_count": 2,
  "removed_queued_jobs": 2
}

Changes

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