Search.../
  1. APIs

removeTask( )

This function will continue to work, but a newer version is available at wix-crm.v2.Tasks.deleteTask().

Description

Migration Instructions

If this function is already in your code, it will continue to work. To stay compatible with future changes, migrate to wix-crm.v2.Tasks.deleteTask().

To migrate to the new function:

  1. Add the new import statement:

    import { tasks } from 'wix-crm.v2'
    javascript | Copy Code

  2. If you plan to migrate all functions that use wixCrmBackend, remove the original import wixCrmBackend statement.

  3. Look for any code that uses wixCrmBackend.tasks.removeTask(), and replace it with with tasks.deleteTask(). Update your code to work with the new deleteTask() call and response properties.

  4. Test your changes to make sure your code behaves as expected.

Removes an existing task.

The removeTask() function returns a Promise that resolves to the ID of the the removed task after it has been successfully removed.

Syntax

function removeTask(taskId: string): Promise<string>

removeTask Parameters

NAME
TYPE
DESCRIPTION
taskId
string

ID of the task to remove.

Returns

Fulfilled - ID of the removed task.

Return Type:

Promise<string>

Was this helpful?

Remove a task

Copy Code
1import { Permissions, webMethod } from 'wix-web-module';
2import { tasks } from 'wix-crm-backend';
3

4export const removeTask = webMethod(Permissions.Anyone, (taskId) => {
5  return tasks.removeTask(taskId);
6});
7

8// 3c9683ea-f6cc-470b-b0d1-2eb6b8cea912 - removed task id