Update milestone

PATCH/api/v1/workspaces/{slug}/projects/{project_id}/milestones/{milestone_id}/

Update a specific milestone by its ID.

Path Parameters

milestone_id:requiredstring

Milestone id.

project_id:requiredstring

Project id.

slug:requiredstring

Slug.

Body Parameters

title:optionalstring

Title.

target_date:optionalstring

Target date.

external_id:optionalstring

External id.

external_source:optionalstring

External source.

Scopes

API key authentication or an OAuth token with equivalent access.

Update milestone

curl -X PATCH \
  "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/milestones/550e8400-e29b-41d4-a716-446655440001/" \
  -H "X-API-Key: $PLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "Example Name",
  "target_date": "2024-01-01",
  "external_id": "550e8400-e29b-41d4-a716-446655440000",
  "external_source": "github"
}'

import requests

response = requests.patch(
    "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/milestones/550e8400-e29b-41d4-a716-446655440001/",
    headers={"X-API-Key": "your-api-key"},
    json={
      "title": "Example Name",
      "target_date": "2024-01-01",
      "external_id": "550e8400-e29b-41d4-a716-446655440000",
      "external_source": "github"
    }
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/milestones/550e8400-e29b-41d4-a716-446655440001/",
  {
    method: "PATCH",
    headers: {
      "X-API-Key": "your-api-key",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      title: "Example Name",
      target_date: "2024-01-01",
      external_id: "550e8400-e29b-41d4-a716-446655440000",
      external_source: "github",
    }),
  }
);
const data = await response.json();

Response200

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "title": "Example Name",
  "target_date": "2024-01-01",
  "external_id": "550e8400-e29b-41d4-a716-446655440000",
  "external_source": "github",
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z"
}