TaskLists: CreateTaskList

Applies a task list to a room, based on the taskTemplateId that you specify in the taskList request body.

Note: You must first create a task list template in the console. You cannot create a task list template by using the API at this time. To get the taskListTemplateId, use the TaskListTemplates::GetTaskListTemplates method.

Permissions

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

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

Request

HTTP request

POST /restapi/v2/accounts/{accountId}/rooms/{roomId}/task_lists

Parameters

Parameter NameValueDescription
Path Parameters
roomIdinteger

(Required) The id of the room.

accountIdstring

(Required) The globally-unique identifier (GUID) for the account.

Request Body

taskList

Responses

CodeDescriptionReference
201

Task lists successfully created.

TaskList
400

Bad request. See ErrorCode and Message for details

ApiError
401

Not authorized to make this request.

ApiError

SDK Method

Rooms::CreateTaskList

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.

TaskList

This response object contains details about the new task list.

taskListIdinteger

The id of the task list.

namestring

The name of the task list.

taskListTemplateIdinteger

The id of the task list template used to create the task list.

submittedForReviewDatestring

The UTC DateTime when the task list was submitted for review.

approvalDatestring

The UTC DateTime when the task list was approved.

rejectedDatestring

The UTC DateTime when the reviewer rejected the task list.

createdDatestring

The UTC date and time when the task list was created. This is a read-only value that the service assigns.

Example: 2019-07-17T17:45:42.783Z

approvedByUserIdinteger

The id of the user who approved the task list.

rejectedByUserIdinteger

The id of the user who rejected the task list.

commentstring

Contains a comment about the task list.

tasks[TaskSummary]

A list of tasks in the task list.

TaskListForCreate

Contains information about the task list template to use to create the new task list.

taskListTemplateIdinteger

(Required) The id of the task list template.

TaskSummary

Contains information about a task list.

taskIdinteger

The id of the task list.

namestring

The name of the task list.

requiresApprovalboolean

When set to true, the task must be completed and reviewed before it can be closed.

dueDateTypeIdstring

The id of the due date type (such as Actual Close Date or Contract Date).

dueDateOffsetinteger

The number of days before or after the due date (specified by the dueDateTypeId) within which the task must be completed. A negative number indicates that the task must be completed within a certain number of days before the due date. A positive number indicates that the task must be completed within a certain number of days after the due date.

fixedDueDatestring

A specific calendar due date for the task.

In the API, this value is a UTC DateTime that does not actually include a time.

Example: 2019-07-17T00:00:00.000Z

ownerUserIdinteger

The id of the user who owns the task.

completionDatestring

The UTC DateTime when the task was completed.

Example: 2019-07-17T17:45:42.783Z

approvalDatestring

The UTC DateTime when the task was approved.

Example: 2019-07-17T17:45:42.783Z

rejectedDatestring

The date on which the reviewer rejected the task.

createdDatestring

The UTC date and time when the task was created. This is a read-only value that the service assigns.

Example: 2019-07-17T17:45:42.783Z

isDocumentTaskboolean

When set to true, the task is associated with a document.

requiresReviewboolean

When set to true, the task is optional. If the task is completed (if a document is added or the task is marked complete), it must be reviewed before it can be closed.

}} />