Cancelling Action Cards
Each card instance is in an open state after it's created. Once a card has been dismissed, completed or expires it will move to a closed state. If a card (or multiple cards) need to be moved into a closed state manually, they can be canceled.
Cancelling cards will not cancel an Action Flow instance which sent the card if it is still active, only active card instances will be cancelled.
Ways to cancel cards
To cancel one or more instance of a card, you can either use the Cancel Cards tool, or the Cards API.
Cancel cards manually from the Workbench
Via the Cancel Cards tool, a workbench member can quickly and easily arrange for cards to be cancelled.
- The tool allows you to find card instances you want to cancel by filtering on user id, card template id, and many other options.
- Before you confirm the cancellation Atomic will confirm how many matching open card instances it has found, so you can sense-check things before proceeding.
- The cancel task can take a while when it involves a large volume of cards, so after confirming the request, you can leave the cancel job to run, and a notification will be sent to you in the workbench confirming when it has completed.
Cancel cards via the Cards API
If you have a scenario where cards may need to be programmatically cancelled, for example, when events occur in a 3rd party system, you can do this from the Cards API. If you plan to use an app like Insomnia/Postman, there are a few tips and links for that here.
What happens to a card instance when it is cancelled?
- A canceled card is no longer visible to the end user
- An analytics event will be tracked to record the cancellation
- If you have an action flow that contains a Wait for card event steps designed to run when the card is cancelled, it will run