Run a previewed bulk operation
bulk_executeExecute a previewed bulk email delete or move using its plan ID. Applies the exact message selection from the plan, valid for one run within 15 minutes.
Instructions
Run a bulk delete or move that was previewed as a plan. Takes only the plan_id: which messages are affected was decided and frozen when the preview was created, and cannot be changed here. A plan runs at most once and expires 15 minutes after it is created.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| plan_id | Yes | The plan_id returned with a bulk preview. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| card | No | Which card this envelope renders. Always 'receipt' here. | |
| state | No | Where the plan stands: executed, cancelled, expired or failed. | |
| receipt | No | What the run actually did: headline, detail and the affected counts. | |
| dashboard_url | No | Absolute link to the signed-in dashboard for this operation. | |
| schema_version | No | Card envelope version. A client that does not know this version should fall back to dashboard_url. |