Partially updates a milestone

Deprecated

This endpoint is deprecated and may be removed in a future release.

This endpoint was deprecated on 2026-02-12.

It is scheduled for sunset on 2027-01-31.

Description

Partially updates a Milestone with a given id.

Options

Path	PATCH Operations Supported	Value Type
/title	replace	string
/remarks	replace	string, null

PATCH /prototype/platform/milestones/{milestoneId}

Required OAuth Scopes

file:write

Parameters

Parameter	In	Type	Required	Description
X-Version	header	string	false	Version of the API (2022-01-01)
milestoneId	path	MilestoneId	true	The unique identifier of a milestone.
body	body	JSONPatchDocument	true	The batch of JSON patch operations to apply

Body parameter example

[
  {
    "op": "replace",
    "path": "/name",
    "value": "New name"
  }
]

Code Samples

curl

curl -X PATCH https://api.app.wdesk.com/prototype/platform/milestones/{milestoneId} \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer {access-token}' \
    -H 'X-Version: 2022-01-01'

httpie

http PATCH https://api.app.wdesk.com/prototype/platform/milestones/{milestoneId} \
    X-Version:2022-01-01 \
    Content-Type:application/json \
    Accept:application/json \
    Authorization:"Bearer {access-token}"

wget

wget --method=PATCH "https://api.app.wdesk.com/prototype/platform/milestones/{milestoneId}" \
    --output-document -  \ 
    --header 'Content-Type: application/json' \ 
    --header 'Accept: application/json' \ 
    --header 'Authorization: Bearer {access-token}' \
    --header 'X-Version: 2022-01-01'

python

import requests

headers = {
  'X-Version': '2022-01-01',
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('https://api.app.wdesk.com/prototype/platform/milestones/{milestoneId}', headers = headers)

print(r.json())

Returns

200 - OK

Returns a Milestone object.

400 - Bad Request

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

401 - Unauthorized

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

403 - Forbidden

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

404 - Not Found

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

500 - Internal Server Error

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

Example Responses

200 Response

{
  "created": {
    "dateTime": "2019-10-28T15:03:27Z",
    "user": {
      "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
    }
  },
  "id": "bWlsZXN0b25lLXYxOjQzODU0ZmU0NmU2MDQ4M2E4MTU0ZjdmMGI3MWI5YjllOjJjNjQzOGFiNDU1NTNkZTY",
  "remarks": "",
  "resource": {
    "document": {
      "document": "16b1f641613847469b7aa1ca29af40b1",
      "revision": "2c6438ab45553de6"
    },
    "type": "document"
  },
  "title": "Start of Q1"
}

Bad Request

{
  "code": "400BadRequest",
  "message": "The request was unacceptable, often due to a missing or invalid parameter"
}

Unauthorized

{
  "code": "401Unauthorized",
  "message": "No valid API token provided"
}

Forbidden

{
  "code": "403Forbidden",
  "message": "The API token does not have permissions to perform the request"
}

Not Found

{
  "code": "404NotFound",
  "message": "The requested resource could not be found"
}

Internal Server Error

{
  "code": "500InternalServerError",
  "message": "The server encountered an unexpected condition that prevented it from fulfilling the request"
}