archiveCard( )


Deprecated. This function is being discontinued in the upcoming months. We are working to provide alternatives, and we'll provide timely updates before implementing any changes. We understand that this transition might present challenges, and we appreciate your patience and understanding.

Archives a workflow card.

The archiveCard() function returns a Promise that resolves when the card has been archived.

This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflow API, see Retrieving IDs.

Method Declaration
Copy
function archiveCard(cardId: string): Promise<void>;
Method Parameters
cardIdstringRequired

ID of the card to archive.

Archive a card
JavaScript
import { Permissions, webMethod } from "wix-web-module"; import { workflows } from "wix-crm-backend"; export const archiveCard = webMethod(Permissions.Anyone, (cardId) => { return workflows.archiveCard(cardId); }); // Returns a promise that resolves to void.
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?