SupDesk API
POST/v1/changelog

Create a changelog entry

Creates a changelog entry with a title and optional body and publication time. Supply title to identify the entry; provide published_at as an ISO 8601 date-time when you want to specify its publication time. The response contains the created entry.

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

3 body fields

Changelog entry details. title is required.

titlestringrequired
The changelog entry title.
bodystringoptional
The changelog entry's content.
published_atstringoptional
The publication date and time in ISO 8601 date-time format.

2 status codes
201Returns the created changelog entry in the `data` object.
dataobjectoptional
401Returned when the request is unauthenticated.
errorobjectoptional

Error handling

title is required. A 401 is returned when the request is unauthenticated. If supplied, published_at must be an ISO 8601 date-time.