PATCH
/api/public/v1/milestones/{milestoneId}

Update a milestone

Rename a milestone, recolor it, or hand it to a new owner. Its owner, or a manager of the project it belongs to.

Required scope

The access token must carry this scope. A token missing it gets 403 Forbidden. Grant them to an API client under Settings → Company → API, and to a teammate under Employee → Permissions.

projects:admin

Path Parameters

NameTypeRequiredDescription
milestoneIdstringRequiredMilestone ID.

Request Body

PropertyTypeDescription
startAtstringISO 8601 — the day the work starts, and what the roadmap’s drag writes once it has snapped the pointer to a day. `null` takes the date off.
endsAtstringISO 8601 — the day the work ends. Must not be earlier than `startAt`. `null` takes the date off.
namestringNew name.
colorstringNew color token.
ownerIdstringActive employee of this company.
PATCHExample request
curl
curl -X PATCH "https://www.pxb.app/api/public/v1/milestones/{milestoneId}" \
  -H "Authorization: Bearer your_access_token" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Billing & invoicing"
  }'
200Example response
json
{
  "message": "Milestone updated successfully!",
  "content": {
    "milestone": {
      "id": "epc_9f8e",
      "name": "Billing",
      "description": "Everything invoicing-related for the rebuild.",
      "color": "violet",
      "status": "IN_PROGRESS",
      "startAt": "2026-07-01T12:00:00.000Z",
      "endsAt": "2026-09-30T12:00:00.000Z",
      "order": 0,
      "projectId": "prj_a1b2c3",
      "projectKey": "APOLLO",
      "projectName": "Apollo billing rebuild",
      "owner": {
        "employeeId": "emp_12ab",
        "name": "Sam Okafor",
        "email": "sam@example.com",
        "avatarUrl": null
      },
      "ticketCount": 6,
      "createdAt": "2026-06-02T10:00:00.000Z"
    }
  }
}
403Example response
json
{
  "message": "Only the milestone owner or a projects admin can edit it."
}

In the console

The same thing done by hand, for anyone comparing the API against the screen they already use.

Projects → Milestones
/projects