Navigation Menu

Update a task

PUT /api/2.0/project/task/{taskid:[0-9]+}

Request

Updates the selected task with the parameters (responsible user ID, task description, deadline time, etc) specified in the request.

Authorization

An API key is a token that you provide when making API calls. Include the token in a header parameter called Authorization.

Example: Authorization: 864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json.

Content-Typeenum of string

Can be one of: application/json.

Body

taskidinteger

Task ID

descriptionstring

New task description

deadlinestring

New task deadline time

startDatestring

New task start date

priorityarray of integer

New task priority

titlestring

New task title

milestoneidinteger

New task milestone ID

responsiblesarray of string

New list of task responsibles

projectIDarray of integer

New task project ID

notifyboolean

Specifies whether to notify responsibles about the task actions or not

statusarray of integer

New task status

progressarray of integer

New task progress

Examples

PUT /api/2.0/project/task/%7Btaskid:[0-9]+%7D HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com
curl --request PUT \
  --url 'https://example.com/api/2.0/project/task/%7Btaskid:[0-9]+%7D' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

Updated task

Filesarray of object
Namestring
UpdatedByobject
Idstringformat: uuid
DisplayNamestring
Titlestring
AvatarSmallstring
ProfileUrlstring
Updatedstring
Locationstring
Commentsarray of object
CommentIDstring
UserIDstringformat: uuid
UserPoststring
UserFullNamestring
UserProfileLinkstring
UserAvatarPathstring
CommentBodystring
Inactiveboolean
IsReadboolean
IsEditPermissionsboolean
IsResponsePermissionsboolean
TimeStampStrstring
CommentListobject
Attachmentsarray of object
FileNamestring
FilePathstring
CommentsCountintegerformat: int32
IsSubscribedboolean
CanEditFilesboolean
CanCreateCommentboolean
Projectobject
CanEditboolean
CanDeleteboolean
Securityobject
CanCreateMilestoneboolean
CanCreateMessageboolean
CanCreateTaskboolean
CanCreateTimeSpendboolean
CanEditTeamboolean
CanReadFilesboolean
CanReadMilestonesboolean
CanReadMessagesboolean
CanReadTasksboolean
CanLinkContactboolean
CanReadContactsboolean
CanEditboolean
CanDeleteboolean
IsInTeamboolean
ProjectFolderobject
IsPrivateboolean
TaskCountintegerformat: int32
TaskCountTotalintegerformat: int32
MilestoneCountintegerformat: int32
DiscussionCountintegerformat: int32
ParticipantCountintegerformat: int32
TimeTrackingTotalstring
DocumentsCountintegerformat: int32
IsFollowboolean
Tagsarray of string
Createdstring
CreatedByobject
Idstringformat: uuid
DisplayNamestring
Titlestring
AvatarSmallstring
ProfileUrlstring
CreatedByIdstringformat: uuid
Updatedstring
UpdatedByobject
Idstringformat: uuid
DisplayNamestring
Titlestring
AvatarSmallstring
ProfileUrlstring
UpdatedByIdstringformat: uuid
Idintegerformat: int32
Titlestring
Descriptionstring
Statusintegerformat: int32
Responsibleobject
Idstringformat: uuid
DisplayNamestring
Titlestring
AvatarSmallstring
ProfileUrlstring
ResponsibleIdstringformat: uuid
TimeSpendnumberformat: double
CanEditboolean
CanCreateSubtaskboolean
CanCreateTimeSpendboolean
CanDeleteboolean
CanReadFilesboolean
Deadlinestring
StartDatestring
MilestoneIdintegerformat: int32
Priorityenum of integerformat: int32

[0 - Normal, 1 - High, -1 - Low]

Can be one of: Normal, High, Low.

ProjectOwnerobject
Idintegerformat: int32
Titlestring
Statusintegerformat: int32
IsPrivateboolean
Progressintegerformat: int32
Subtasksarray of object
CanEditboolean
TaskIdintegerformat: int32
Createdstring
CreatedByobject
Idstringformat: uuid
DisplayNamestring
Titlestring
AvatarSmallstring
ProfileUrlstring
CreatedByIdstringformat: uuid
Updatedstring
UpdatedByobject
Idstringformat: uuid
DisplayNamestring
Titlestring
AvatarSmallstring
ProfileUrlstring
UpdatedByIdstringformat: uuid
Idintegerformat: int32
Titlestring
Descriptionstring
Statusintegerformat: int32
Responsibleobject
Idstringformat: uuid
DisplayNamestring
Titlestring
AvatarSmallstring
ProfileUrlstring
ResponsibleIdstringformat: uuid
Linksarray of object
DependenceTaskIdintegerformat: int32
ParentTaskIdintegerformat: int32
LinkTypeenum of integerformat: int32

[0 - Start, 1 - End, 2 - EndStart]

Can be one of: Start, End, EndStart.

Responsiblesarray of object
Idstringformat: uuid
DisplayNamestring
Titlestring
AvatarSmallstring
ProfileUrlstring
ResponsibleIdsarray of string
Milestoneobject
Idintegerformat: int32
Titlestring
Deadlinestring
CustomTaskStatusarray of integer
Createdstring
CreatedByobject
Idstringformat: uuid
DisplayNamestring
Titlestring
AvatarSmallstring
ProfileUrlstring
CreatedByIdstringformat: uuid
Updatedstring
UpdatedByobject
Idstringformat: uuid
DisplayNamestring
Titlestring
AvatarSmallstring
ProfileUrlstring
UpdatedByIdstringformat: uuid
Idintegerformat: int32
Titlestring
Descriptionstring
Statusintegerformat: int32
Responsibleobject
Idstringformat: uuid
DisplayNamestring
Titlestring
AvatarSmallstring
ProfileUrlstring
ResponsibleIdstringformat: uuid

401

Unauthorized

Get Help

  • If you have any questions about ONLYOFFICE Workspace, try the FAQ section first.
  • You can request a feature or report a bug by posting an issue on GitHub.
  • You can also ask our developers on ONLYOFFICE forum (registration required).