Sign in

v1

latestOpenAPI 3.0.3RingCentral API License Agreement2026-08-064871,2921.5 MB
Tasks

Create Task

Creates a task in the specified chat.

post/team-messaging/v1/chats/{chatId}/tasks

Path parameters

chatIdstring required

Internal identifier of a chat

Request body

subjectstring required

Task name/subject. Max allowed length is 250 characters

completenessCondition'Simple' | 'AllAssignees' | 'Percentage'
startDatestring date-time

Task start date in UTC time zone.

dueDatestring date-time

Task due date/time in UTC time zone.

color'Black' | 'Red' | 'Orange' | 'Yellow' | 'Green' | 'Blue' | 'Purple' | 'Magenta'
sectionstring

Task section to group / search by. Max allowed length is 100 characters.

descriptionstring

Task details. Max allowed length is 102400 characters (100kB).

Response

Task information

idstring

Internal identifier of a task

creationTimestring date-time

Task creation date/time in UTC time zone

lastModifiedTimestring date-time

Task the last modified time in UTC time zone

type'Task'

Task type

chatIdsstring[]

Internal identifiers of the chats where the task is posted or shared

status'Pending' | 'InProgress' | 'Completed'

Task execution status

subjectstring

Task name/subject

completenessCondition'Simple' | 'AllAssignees' | 'Percentage'

How the task completeness should be determined

completenessPercentageinteger

Current completeness percentage of the task with the specified percentage completeness condition

startDatestring date-time

Task start date

dueDatestring date-time

Task due date/time

color'Black' | 'Red' | 'Orange' | 'Yellow' | 'Green' | 'Blue' | 'Purple' | 'Magenta'

Font color of a post with the current task

sectionstring

Task section to group / search by

descriptionstring

Task details