Sign in

v1

latestOpenAPI 3.0.12026-07-24241275527.9 KB
Tasks

Create Task (Folder)

Create a task in a folder. The folder specified by {folderId} will become the 'parent' folder for the new task. To create a task in the account root, use the Root Folder API ID. When creating a subtask, use the Root API ID as {folderId} and specify the parent task in the 'superTasks' parameter.

<b>Scopes:</b> Default, wsReadWrite

post/folders/{folderId}/tasks

Path parameters

folderIdstring required

Query parameters

titlestring required

Title of task, required

Title of task, required

descriptionstring

Description of task, will be left blank, if not set

Description of task, will be left blank, if not set

status'Active' | 'Deferred' | 'Completed' | 'Cancelled'
  • Active - Active
  • Deferred - Deferred
  • Completed - Completed
  • Cancelled - Cancelled

Status of task. Not available for the Team plan

  • Active - Active
  • Deferred - Deferred
  • Completed - Completed
  • Cancelled - Cancelled
importance'High' | 'Low' | 'Normal'
  • High
  • Low
  • Normal

Importance of task

  • High
  • Low
  • Normal

Task dates. If not specified, a backlogged task is created

Shares task with specified users or invitations. The task is always shared with the author.

Parent folders for newly created task. Can not contain recycleBinId

Makes specified users or invitations assignee for the task

Makes specified placeholders assignee for the task

Add specified users to task followers

followboolean

Follow task

Follow task

priorityBeforestring

Put newly created task before specified task in task list

priorityAfterstring

Put newly created task after specified task in task list

Add the task as subtask to specified tasks

Metadata to be added to newly created task. Limit : 100

List of custom fields to set in newly created task. Limit : 100

customStatusstring

Custom status ID

Set Task Effort fields: mode, total Effort

billingType'Billable' | 'NonBillable'
  • Billable - Billable
  • NonBillable - Non-Billable

Task's timelogs billing type

  • Billable - Billable
  • NonBillable - Non-Billable
withInvitationsboolean

Include invitations in sharedIds & responsibleIds lists

Include invitations in sharedIds & responsibleIds lists

customItemTypeIdstring

Custom Item Type ID to create a task from

Custom Item Type ID to create a task from

plainTextCustomFieldsboolean

Strip HTML tags from custom fields

Strip HTML tags from custom fields

workScheduleIdstring

Id of work schedule to assign to task

Json string array of optional fields to be included in the response model

  • customItemTypeId - Custom Item Type ID
  • billingType - Billing type
  • workScheduleId - Id of work schedule assigned to task
  • effortAllocation - Effort Allocation
  • responsiblePlaceholderIds - List of placeholder assignee IDs

Response

success response

kind'accounts' | 'users' | 'contacts' | 'assets' | 'eDiscoveryReport' | 'folders' | 'folderTree' | 'tasks' | 'taskIds' | 'timelogs' | 'timelogCategories' | 'timelogLockPeriods' | 'timetrackerTimers' | 'comments' | 'attachments' | 'url' | 'version' | 'dataExport' | 'dataExportSchema' | 'auditLog' | 'accessRoles' | 'stream' | 'changes' | 'posts' | 'mailSettings' | 'integrationInfo' | 'gmailIntegrationSettings' | 'workTypesForIntegrations' | 'ids' | 'backups' | 'domains' | 'dependencies' | 'workflows' | 'workschedules' | 'workscheduleExclusions' | 'workscheduleUserExclusions' | 'customfields' | 'customfieldIds' | 'customstatuses' | 'invitations' | 'notifications' | 'jobroles' | 'placeholders' | 'groups' | 'session' | 'dashboards' | 'widgets' | 'taskCreationSettings' | 'colors' | 'experiments' | 'topics' | 'topicComments' | 'webhooks' | 'reviews' | 'boards' | 'textSearch' | 'chatChannels' | 'chatMessages' | 'forms' | 'requestForms' | 'request' | 'report' | 'platformWidgets' | 'platformWidgetInstances' | 'spaces' | 'pdf' | 'customerSatisfaction' | 'asyncJob' | 'approvals' | 'highlights' | 'highlightsList' | 'highlightsSettings' | 'highlightsCard' | 'timesheet' | 'timesheetRow' | 'timesheetSubmissionRule' | 'mobileFeatures' | 'mobileSettings' | 'folderBlueprintTree' | 'taskBlueprintTree' | 'feedback' | 'timeline_snapshot' | 'contactIds' | 'bookings' | 'integrateThreshold' | 'hourlyRatesProvision' | 'hourlyRates' | 'projectTeamMembers' | 'contactsHistory' | 'tasksHistory' | 'foldersHistory' | 'activityDigest' | 'workItemTemplates' | 'workTemplates' | 'workItemMetadata' | 'workItem' | 'customItemTypes' | 'verificationCode' | 'views' | 'listView' | 'tableView' | 'userTypes' | 'reactions' | 'externalRequesters' | 'workscheduleCapacityOverrides' | 'userCapacityOverrides' | 'userCapacityExclusions' | 'rollups' | 'requestFormPrefill' | 'userAggregatedCapacity' | 'cascadingFieldSettings'