GitHub API (unofficial showcase)
PATCH/repos/{owner}/{repo}/milestones/{milestone_number}

Update a repository milestone

Updates an existing milestone in a repository. Identify it with milestone_number and provide only the milestone properties you want to change; state can be open or closed.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

3 parameters · 4 body fields
ownerstringrequired
The account owner of the repository; the name is not case sensitive.
repostringrequired
The repository name without the `.git` extension; the name is not case sensitive.
milestone_numberintegerrequired
The number that identifies the milestone.

Milestone properties to update. All fields are optional.

titlestringoptional
The title of the milestone.
statestringoptional
The state of the milestone. Either `open` or `closed`.
Allowed:openclosedDefault:open
descriptionstringoptional
A description of the milestone.
due_onstringoptional
The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.

1 status code
200Returns the updated milestone object, including its number, title, state, description, due date, and issue counts.
urlstringrequired
html_urlstringrequired
labels_urlstringrequired
idintegerrequired
node_idstringrequired
numberintegerrequired
The number of the milestone.
statestringrequired
The state of the milestone.
Allowed:openclosedDefault:open
titlestringrequired
The title of the milestone.
descriptionstringrequired
creatorobjectrequired
A GitHub user.
open_issuesintegerrequired
closed_issuesintegerrequired
created_atstringrequired
updated_atstringrequired
closed_atstringrequired
due_onstringrequired

Error handling

title, state, description, and due_on are optional; if supplied, state must be open or closed, and due_on must use ISO 8601 date-time format. The milestone_number path parameter must identify a milestone in the repository specified by the owner and repo path parameters.