Update a milestone

PUT /api/2.0/project/milestone/{id:[0-9]+}

Request

Updates the selected milestone changing the milestone parameters (title, deadline, status, 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

idinteger

Milestone ID

titlestring

New milestone title

deadlinestring

New milestone deadline

isKeyarray of boolean

Specifies if this is a key milestone or not

statusinteger

New milestone status ("Open" or "Closed")

isNotifyarray of boolean

Specifies whether to remind me 48 hours before the milestone due date or not

descriptionstring

New milestone description

projectIDinteger

New project ID

responsiblestring

New milestone responsible

notifyResponsibleboolean

Specifies whether to notify responsible about the milestone actions or not

Examples

PUT /api/2.0/project/milestone/%7Bid:[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/milestone/%7Bid:[0-9]+%7D' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

Updated milestone

ProjectOwnerobject
Idintegerformat: int32
Titlestring
Statusintegerformat: int32
IsPrivateboolean
Deadlinestring
IsKeyboolean
IsNotifyboolean
CanEditboolean
CanDeleteboolean
ActiveTaskCountintegerformat: int32
ClosedTaskCountintegerformat: 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

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).