PATCH /milestones/{id}

1 min

PATCH

https://api.cmp.optimizely.com/v3/milestones/{id}

Experimental Updates a milestone. All fields are optional. Only provided fields will be updated. Note: If tasks array is empty, it will remove all task associations for that milestone.

Path Parameters

idstringrequired
Example
63f1c2b675be4132854d2741
Description
Unique identifier of the milestone

Body Parameters

bodyMilestoneUpdateRequestrequired
Description
Payload to update a milestone
- titlestring
  Example
  Q1 Product Launch
  Description
  Title of the milestone. This should be between 1 and 80 characters.
  Min Length
  1
  Max Length
  80
- descriptionstring
  Example
  Complete all tasks for the Q1 product launch
  Description
  Description of the milestone. If provided, this should be between 1 and 250 characters.
  Min Length
  1
  Max Length
  250
- campaign_idstring
  Example
  63f1c2b675be4132854d2741
  Description
  Id of the campaign to be associated with the milestone
- due_datestring<date-time>
  Example
  2023-10-07T13:15:30Z
  Description
  Date and time on which the milestone will expire, in ISO 8601 UTC format
  Format
  date-time
- hex_colorstring
  Example
  #4ECFD5
  Description
  Hex color code for the milestone label
- tasksobject[]
  Example
```
[
  {
    "id": "63f1c2b675be4132854d2741"
  },
  {
    "id": "63f1c2b675be4132854d2742"
  }
]
```
  Description
  List of tasks to be associated with the milestone. This can be an empty array, but in that case it will remove all task associations for that milestone.
  - idstringrequired
    Description
    Task ID

Responses

200Updated milestone

MilestoneResponse
- idstringrequired
  Example
  63f1c2b675be4132854d2741
  Description
  Unique identifier of the milestone
- titlestringrequired
  Example
  Sample Milestone
  Description
  Title of the milestone
- colorstringrequired
  Example
  #4ECFD5
  Description
  Color of the milestone label
- descriptionstringrequired
  Example
  This is a milestone
  Description
  Description of the milestone
- due_datestring<date-time>required
  Example
  2023-10-07T13:15:30Z
  Description
  Date and time on which the milestone will expire, in ISO 8601 UTC format
  Format
  date-time
- campaignobjectrequired
  Description
  Campaign associated with the milestone
  - idstringrequired
    Example
    63f1c2b675be4132854d2742
    Description
    Unique identifier of the campaign
- linksobjectrequired
  Description
  Meta links
  - selfstringrequired
    Example
    https://api.cmp.optimizely.com/v3/milestones/63f1c2b675be4132854d2741
    Description
    URL of the milestone

400Client error

Error
Example
```
{
  "message": "Unsupported arguments: a,b,c"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

401Authorization error

Error
Example
```
{
  "message": "Unauthorized"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

403Permission error

Error
Example
```
{
  "message": "You do not have the permission to perform this operation"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

404Not found error

Error
Example
```
{
  "message": "Resource not found"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

422Unprocessable entity error

Error
Example
```
{
  "message": "Resource cannot be processed"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

curl

curl --request PATCH \
     --url https://api.cmp.optimizely.com/v3/milestones/{id} \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "tasks": [
     {
     "id": ""
     }
     ]
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var raw = JSON.stringify({
   "tasks": [
      {
         "id": ""
      }
   ]
});

var requestOptions = {
   method: 'PATCH',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.cmp.optimizely.com/v3/milestones/{id}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.cmp.optimizely.com/v3/milestones/{id}")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "tasks": [
      {
         "id": ""
      }
   ]
})

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.cmp.optimizely.com/v3/milestones/{id}"

payload = json.dumps({
   "tasks": [
      {
         "id": ""
      }
   ]
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("PATCH", url, headers=headers, data=payload)

print(response.text)

200

// Updated milestone
{
  "id": "63f1c2b675be4132854d2741",
  "title": "Sample Milestone",
  "color": "#4ECFD5",
  "description": "This is a milestone",
  "due_date": "2023-10-07T13:15:30Z",
  "campaign": {
    "id": "63f1c2b675be4132854d2742"
  },
  "links": {
    "self": "https://api.cmp.optimizely.com/v3/milestones/63f1c2b675be4132854d2741"
  }
}

400

// Client error
{
  "message": "Not found",
  "errors": ""
}

401

// Authorization error
{
  "message": "Not found",
  "errors": ""
}

403

// Permission error
{
  "message": "Not found",
  "errors": ""
}

404

// Not found error
{
  "message": "Not found",
  "errors": ""
}

422

// Unprocessable entity error
{
  "message": "Not found",
  "errors": ""
}