Add a milestone

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

Request

Adds a new milestone using the parameters (project ID, milestone title, deadline, 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

Project ID

titlestring

Milestone title

deadlinestring

Milestone deadline

isKeyboolean

Specifies if this is a key milestone or not

isNotifyboolean

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

descriptionstring

Milestone description

responsiblestring

Milestone responsible

notifyResponsibleboolean

Specifies whether to notify responsible about the milestone actions or not

Examples

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

Responses

200

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