Actions18
- Letter Actions
- Batch Actions
- Letter Event Actions
Batch → Delete
AI-generatedSummary
Deletes a batch from the Pingen API using a batch ID.
Inputs
- environment (required) — Which Pingen environment to use. Each maps to a separate credential.
- organisationId (required) — Select your Pingen organisation. Choose from the list, or specify an ID using an expression.
- batchId (required) — The ID of the batch to act on (UUID from the create response or Pingen UI).
Output shape
a single record
Returns a flattened JSON:API object containing the batch data (ID, type, attributes). If the API returns no body (204 No Content), the node returns a JSON object with deleted: true and the batchId.
Examples
Example 1: Clean up a batch after it has been cancelled or is no longer needed.
Set Environment to 'production' or 'staging', select an Organisation, and enter the Batch ID.