Initiates a request to create a new 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

Create a new Milestone using a MilestoneCreation request. This is a long running operation. Responses include a Location header, which indicates where to poll for results. For more details on long-running job polling, see Operations endpoint. When the creation completes, its status will be completed, and the response body includes a resourceURL. To GET the new milestone, perform a GET on the resourceURL with the same authentication credentials and flow as the initial request. For more details, see Authentication documentation.

POST /prototype/platform/milestones/creation

Required OAuth Scopes

file:write

Parameters

Parameter	In	Type	Required	Description
X-Version	header	string	false	Version of the API (2022-01-01)
body	body	MilestoneCreation	true	The milestone to create

Body parameter example

{
  "document": "16b1f641613847469b7aa1ca29af40b1",
  "presentation": "16b1f641613847469b7aa1ca29af40b1",
  "remarks": "",
  "spreadsheet": "16b1f641613847469b7aa1ca29af40b1",
  "title": "string",
  "type": "document"
}

Code Samples

curl

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

httpie

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

wget

wget --method=POST "https://api.app.wdesk.com/prototype/platform/milestones/creation" \
    --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.post('https://api.app.wdesk.com/prototype/platform/milestones/creation', headers = headers)

print(r.headers['Location'])

Returns

202 - Accepted

Header	Description
Location	The location to poll for the operation result.
Retry-After	The number of seconds to wait before polling for a result and between polling attempts.

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.

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

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"
}

Internal Server Error

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