Delete a post
delete_postRemove a post this key created that has not gone out. A draft, a post waiting for approval, a rejected or a failed one is deleted with its delivery records. A post already holding a time is taken off the schedule instead, and unscheduled with message says so. Posts a person approved are refused, and so is one that has gone out — removing THAT from the platform is take_down_post.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| post_id | Yes | The post id from create_post |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | ||
| ok | No | Present and false only on a refusal. | |
| error | No | What was refused, in a sentence, when `ok` is false. | |
| status | No | ||
| deleted | No | Gone permanently, with its delivery records. | |
| message | No | ||
| retriable | No | False when asking again cannot change the answer. | |
| error_code | No | Machine reason for a refusal. | |
| replaced_by | No | The id the post has now, when you asked with one an edit retired. An edit gives a post a new id: get_delivery_receipt and get_post_metrics answer for this current version (and `asked_for` is the id you sent); update_post and delete_post refuse with error_code `replaced`. Use this id from here on. | |
| unscheduled | No | Taken off the schedule and handed back to the user instead of deleted. |