Skip to main content
PATCH
/
milestones
/
{id}
Update milestone
curl --request PATCH \
  --url https://api.onset.io/v1/milestones/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "title": "<string>",
  "body": "<string>",
  "status": "<string>",
  "slug": "<string>",
  "is_public": true,
  "project_id": "<string>",
  "label_ids": [
    "<string>"
  ],
  "attachments": [
    {
      "id": "<string>",
      "type": "FILE",
      "content": {
        "title": "<string>",
        "url": "<string>",
        "size": 123,
        "type": "<string>"
      }
    }
  ]
}'
{
  "id": "<string>",
  "title": "<string>",
  "body": "<string>",
  "slug": "<string>",
  "status": "<string>",
  "stage": "<string>",
  "is_public": true,
  "upvote_count": 123,
  "project": {
    "id": "<string>",
    "name": "<string>",
    "slug": "<string>"
  },
  "labels": [
    {
      "id": "<string>",
      "name": "<string>",
      "slug": "<string>",
      "color": "<string>"
    }
  ],
  "attachments": [
    {
      "type": "FILE",
      "content": {
        "title": "<string>",
        "url": "<string>",
        "size": 123,
        "type": "<string>"
      },
      "id": "<string>"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Milestone ID

Body

application/json
title
string
required

Milestone title

Required string length: 3 - 255
status
string
required

Milestone status ID

slug
string
required

URL-friendly milestone identifier

Required string length: 3 - 255
body
string

Milestone description/body content

is_public
boolean

Whether milestone should be publicly visible

project_id
string | null

ID of the project this milestone belongs to

label_ids
string[]

Array of label IDs to attach to the milestone

attachments
object[]

Array of attachments to include

  • Option 1
  • Option 2

Response

Milestone updated successfully

id
string

Unique milestone identifier

title
string

Milestone title

body
string

Milestone description/body content (HTML formatted)

slug
string

URL-friendly milestone identifier

status
string

Current milestone status

stage
string

Current milestone stage

is_public
boolean

Whether milestone is publicly visible

upvote_count
integer

Number of votes for this milestone

project
object
labels
object[]
attachments
object[]
  • Option 1
  • Option 2
created_at
string<date-time>

When the milestone was created

updated_at
string<date-time>

When the milestone was last updated

I