v1Resources/Posts/deleteUnpublish and delete a post

Unpublish and delete a post

Unpublishes a post from every platform it was submitted to — a real, immediate action that can't be undone. Only once every platform unpublish succeeds does the post also disappear from this API; if any platform fails, nothing is archived and the post stays visible so the failure can be retried. This API never permanently deletes the post record.

delete/api/v1/posts/{id}

posts:write

Query parameters

idstringrequired

The post to delete.

Response

dataobjectoptional

idstringoptional

Unique identifier for the post.

okbooleanoptional

Whether every platform submission was successfully unpublished.

deletednumberoptional

Number of platform submissions successfully unpublished.

failedarray of objectoptional

Platform submissions that failed to unpublish, if any.

connectionIdstringoptional

ID of the connection whose unpublish failed.

platformstringoptional

The platform this row is for.

errorstringoptional

Error message describing why the unpublish failed.

Errors

401Missing, invalid, expired, or revoked API key.

403The key lacks the required scope, or isn't authorized for this client/location.

404The resource wasn't found, or doesn't belong to your agency.

429Too many requests. Retry after the number of seconds in the Retry-After header.

delete/api/v1/posts/{id}

Your API key

id *

{
  "data": {
    "id": "cm_post_abc123",
    "ok": true,
    "deleted": 2,
    "failed": []
  }
}