Edit a pending send
approval_updateUpdate the subject or body of an email waiting for human approval before it is reviewed and sent.
Instructions
Change the subject or body of a send that is waiting for human approval. The message still has to be approved afterwards, and the reviewer sees the edited version. Subject can only be set on operations that carry one (email_send, schedule_create).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| subject | No | Replacement subject line. | |
| body_html | No | Replacement HTML body. | |
| body_text | No | Replacement plain-text body. Unless body_html is supplied in the same call, the HTML part is regenerated from this text so both parts of the message say the same thing. Include the signature if the body you are replacing had one. | |
| approval_id | Yes | The approval_id returned by a gated send (status: "pending_approval"). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| card | No | Which card this envelope renders: 'outbound_review' or 'receipt'. | |
| state | No | Where the request stands: pending, approved, rejected, expired or sent. | |
| dashboard_url | No | Absolute link to the signed-in approvals page. Always present, and the one link that still works when the rest of the envelope cannot be parsed. | |
| schema_version | No | Card envelope version. A client that does not know this version should fall back to dashboard_url. |