SupDesk
PATCH/v1/changelog/{id}

Update a changelog entry

Updates an existing changelog entry. Supply one or more of title, body, or published_at to change those fields; omitted fields are not part of the update. Use id to identify the entry to update.

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

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

Fields to update on the changelog entry; all listed fields are optional.

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` object.
dataobjectoptional
401Returned when the request has missing or invalid authentication credentials.
errorobjectoptional
404Returned when no changelog entry exists with the given `id`.
errorobjectoptional

Error handling

A 401 is returned when the request has missing or invalid authentication credentials. A 404 is returned when no changelog entry exists with the given id path parameter.