TaskLists: DeleteTaskList

Deletes the specified task list from a room. If there are attached documents, they will remain in the associated room.

Permissions

Rooms Version 6: You must have the canRemoveAnyTaskList permission set to true:

Rooms Version 5: You must either be the owner or co-owner of the room or have a Manager/Admin role for which the canManageCompanyRooms permission is set to true.

Request

HTTP request

DELETE /restapi/v2/accounts/{accountId}/task_lists/{taskListId}

Parameters

Parameter NameValueDescription
Path Parameters
taskListIdinteger

The id of the task list.

accountIdstring

The globally unique identifier (GUID) for the account.

Responses

CodeDescriptionReference
204

Task list successfully deleted.

400

Bad request. See ErrorCode and Message for details

ApiError
401

Not authorized to make this request.

ApiError

SDK Method

TaskLists::DeleteTaskList

Definitions

ApiError

This object describes errors that occur. It is valid only for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

}} />