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.
function archiveCard(cardId: string): Promise<void>;ID of the card to archive.
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.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.
Creates a new workflow card.
The createCard() function returns a Promise that resolves to the created card's
ID when the card is created in the specified workflow phase.
Pass a value for the position parameter to specify the newly created card's
position within the specified phase. Positions are zero-based, meaning the first position is0.
When omitted, the newly created card is added to the specified phase as the top card within the phase.
This function requires you to specify the ID of a workflow and phase. To learn about retrieving IDs in the Workflow API, see Retrieving IDs.
Note:
Each workflow is limited to 5,000 cards.
If this limit is reached, createCard() throws an error.
Archive cards when they're no longer needed
to reduce card count and avoid hitting the limit.
ID of the workflow to create the card in.
ID of the phase to create the card in.
Card to create.
The created card's position within the workflow.
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.
Creates a new workflow phase.
The createPhase() function returns a Promise that resolves to the created phase
ID when the phase is created in the specified workflow.
Pass a value for the position parameter to specify the newly created phase's
position within the specified workflow. Positions are zero-based, meaning the first position is 0.
When omitted, the newly created phase is added as the last non-win phase.
This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflow API, see Retrieving IDs.
ID of the workflow to add the new phase to.
Phase to create.
The created phase's position within the workflow.
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.
Creates a new workflow.
The createWorkflow() function returns a Promise that resolves to the created workflow
ID.
Workflow to create.
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.
Deletes a workflow card by ID.
The deleteCard() function returns a Promise when the specified card
has been deleted.
This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflow API, see Retrieving IDs.
ID of the card to delete.
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.
Deletes a workflow phase.
The deletePhase() function returns a Promise when the specified phase
has been deleted.
This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflow API, see Retrieving IDs.
ID of the phase to delete.
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.
Deletes a workflow.
The deleteWorkflow() function returns a Promise when the specified workflow
has been deleted.
This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflow API, see Retrieving IDs.
ID of the workflow to delete.
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.
Retrieves a workflow card by ID.
The getCard() function returns a Promise that resolves to the card
with the specified ID.
This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflow API, see Retrieving IDs.
ID of the card to retrieve.
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.
Retrieves a phase by ID.
The getPhaseInfo() function returns a Promise that resolves to the phase
with the specified ID.
This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflow API, see Retrieving IDs.
ID of the phase to retrieve.
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.
Retrieves a workflow by ID.
The getWorkflowInfo() function returns a Promise that resolves to the workflow info
with the specified ID.
This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflow API, see Retrieving IDs.
ID of the workflow to retrieve.
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.
Retrieves a list of a workflow's cards.
The listCards() function returns a Promise that resolves to a list of the
the specified workflow's cards.
Use the options parameter to specify which cards to retrieve and in which
order to retrieve them. Must use either phaseId or fetchOnlyArchived.
Cards can be sorted based on their "id", "name",
"phaseId", "createdDate", "updatedDate", "source", and "position".
If no limit parameter is passed, the first 50 cards are returned. Sort order
defaults to by "phaseId" and then by "position" ascending.
This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflow API, see Retrieving IDs.
ID of the workflow to retrieve cards from.
Options to use when retrieving the list of cards.