Milestones

Update milestone

Changed on

Update a milestone. Both name and milestone_date are required.

Permissions: Requires write access to the site (manage:{site_id}).

Returns: A milestone object.

post/sites/{site_id}/milestones/{milestone_id}

Request

  • Base URL
    https://api.usefathom.com/v1
  • URL
    https://api.usefathom.com/v1/sites/{site_id}/milestones/{milestone_id}
  • Auth
    HTTP bearer

Path parameters

site_idstring required
Example:CDBUGS

The ID of the site. This is the same string you use in your tracking code. Example: CDBUGS

milestone_idstring required
Example:ddc9cdff-ab83-41fa-96c6-dfb276a862e7

The id (UUID) of the milestone you wish to update.

Request body

namestring required

The name of the milestone (up to 30 characters).

milestone_datestring required

The date of the milestone in YYYY-MM-DD format.

Example request

{
  "name": "Website Redesign Launch v2",
  "milestone_date": "2024-01-20"
}

Response

Successful response

Changes

    • breaking

      added the new path request parameter milestone_id

    • breaking

      added the new path request parameter site_id

    • breaking

      the request property became required

    • breaking

      the request property became required

    • info

      api operation id updateMilestone was added

    • info

      api tag Milestones added

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status