PATCH/v1/changelog/{id}

Update a changelog entry

Updates an existing changelog entry. Supply the fields you want to change: title, body, or published_at; the request updates the entry identified by id. A 200 response returns the updated changelog entry.

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

1 parameter · 3 body fields
idstringrequired
The unique identifier of the changelog entry to update.

The changelog entry fields to update.

titlestringoptional
The title of the changelog entry.
bodystringoptional
The body text of the changelog entry.
published_atstringoptional
The publication date and time in date-time format.

3 status codes
200Returns the updated changelog entry in the `data` field.
dataobjectoptional
401Returned when the request is unauthenticated.
errorobjectoptional
404Returned when the changelog entry does not exist.
errorobjectoptional

Error handling

A 401 is returned when the request is unauthenticated. A 404 is returned when the id path parameter does not identify an existing changelog entry.