Actions18
- Letter Actions
- Batch Actions
- Letter Event Actions
Batch → Cancel
AI-generatedSummary
Cancels a batch that has not yet been sent.
Inputs
- environment (required) — Select the Pingen environment (Production or Staging). Each maps to a separate credential.
- organisationId (required) — Select your Pingen organisation or specify an ID using an expression.
- batchId (required) — The ID of the batch to cancel (UUID).
Output shape
A single batch record (JSON object) containing the updated batch details.
The operation performs a PATCH request to the Pingen API. If the batch is already sent or processed, the API may reject the cancellation.
Examples
Example 1: Cancel a batch before sending
Set Environment to 'production', select an Organisation, and enter the Batch ID.