Take a live post down
take_down_postDelete a published post from its platforms, by its post_id — every platform it is live on, or only platform. There is no need to call get_delivery_receipt first. There is no undo; reposting is a new post with a new URL. This is the person's own decision about their live post, not a cleanup step. Each delivery answers in deliveries: error_code never_went_out, account_gone or unsupported means the person removes it on the platform themselves; only platform_refused is retriable. delivery_id still takes down one delivery; a post id passed there answers is_post_id with the post's deliveries.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| post_id | No | The post id from create_post or list_posts | |
| platform | No | Only take it down here, e.g. `x`. Omit for every platform it is live on. | |
| delivery_id | No | One delivery's `id` from get_delivery_receipt, instead of post_id |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | ||
| ok | No | Present and false only on a refusal. | |
| data | No | The receipt after the take-down. | |
| error | No | What was refused, in a sentence, when `ok` is false. | |
| post_id | No | ||
| retriable | No | False when asking again cannot change the answer. | |
| deliveries | No | Each live delivery's own answer; one platform refusing does not stop the others. | |
| error_code | No | Machine reason for a refusal. | |
| taken_down | No | Gone from the platform — true, or how many deliveries came down. No undo. | |
| post_status | No | ||
| 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. | |
| preview_link | No | ||
| approval_link | No |