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.

Description

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.

Syntax

function archiveCard(cardId: string): Promise<void>

archiveCard Parameters

NAME

TYPE

DESCRIPTION

cardId

string

ID of the card to archive.

Returns

Fulfilled - When the card has been archived.

Return Type:

Promise<void>

Was this helpful?

Archive a card

Copy Code

1import { Permissions, webMethod } from 'wix-web-module';
2import { workflows } from 'wix-crm-backend';
3
4export const archiveCard = webMethod(Permissions.Anyone, (cardId) => {
5  return workflows.archiveCard(cardId);
6});
7
8// Returns a promise that resolves to void.