latestOpenAPI 3.0.02026-08-216686147.9 KB

6f6009a58cdd

milestones

Update the specified Milestone

patch/v1/milestones/{uuid}

Path parameters

uuidstring uuid required

The UUID of the Milestone to update

Request body

namestring

due_datestring date nullable

sequenceinteger

The Milestone's stored display sequence.

client_can_viewboolean

Whether client users can view the Milestone.

owner_user_uuidstring uuid nullable

UUID of the firm user assigned to own the Milestone.

associated_engagement_status'Pending' | 'In Progress' | 'Complete' | 'Archived'

An optional association to an Engagement lifecycle phase. It does not change the Engagement's current status or determine Milestone completion.

Example request

{
  "name": "Planning complete",
  "due_date": "2026-03-15",
  "sequence": 1
}

Response

The updated Milestone

Example response

{
  "data": {
    "uuid": "4d50d252-be0c-4d69-b77a-5bbdfef83f54",
    "engagement_uuid": "821e8d9e-d2a8-480f-9187-5a685d3d0d71",
    "name": "Planning complete",
    "sequence": 2,
    "due_date": "2026-03-15",
    "completed_at": "2026-03-10T12:30:00.000Z",
    "completed_by_user_uuid": "6b242248-e2b9-4d41-8986-11b710860048",
    "owner_user_uuid": "ee196968-2a7a-48e9-97f9-d12f26a8ff94",
    "client_can_view": true,
    "created_at": "2026-02-01T12:30:00.000Z",
    "updated_at": "2026-03-10T12:30:00.000Z",
    "_links": {
      "self": {
        "href": "https://example.com/resource/or/path",
        "title": "A description for the link",
        "type": "text/html"
      },
      "collection": {
        "href": "https://example.com/resource/or/path",
        "title": "A description for the link",
        "type": "text/html"
      },
      "engagement": {
        "href": "https://example.com/resource/or/path",
        "title": "A description for the link",
        "type": "text/html"
      },
      "fieldguide": {
        "href": "https://example.com/resource/or/path",
        "title": "A description for the link",
        "type": "text/html"
      }
    }
  }
}