Actions25
- Document Actions
- Template Actions
Document → Delete
AI-generatedSummary
Delete specified document signing requests by providing their request IDs, with an option to include requests that are currently in progress.
Inputs
- Request IDs to Delete (required) — A JSON string containing an array under the 'data' key with the request IDs to delete, e.g., {"data": ["38002000000062395"]}.
- In Progress (required) — Boolean flag indicating whether to delete requests that are currently in progress. Set to true to delete in-progress requests; false to delete only completed or non-in-progress requests.
- Reason (required) — The reason for deletion, required only if 'In Progress' is true, to explain why in-progress requests are being deleted.
Output shape
a single JSON object confirming the result of the deletion operation
The node sends a PUT request to the API endpoint 'requests/delete' and returns the API response confirming which requests were deleted or any error encountered. The response includes details regardless of whether in-progress requests were included in the deletion.
Examples
Example 1: Delete specific completed document requests
Set 'Request IDs to Delete' with a JSON array of request IDs to remove, set 'In Progress' to false to delete only those that are not in progress.
Example 2: Delete specific document requests including those in progress
Set 'Request IDs to Delete' with a JSON array of request IDs, set 'In Progress' to true, and provide a non-empty 'Reason' to delete in-progress requests as well.