Skip to main content
POST
Create a changelog update

Authorizations

Authorization
string
header
required

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

Body

application/json
title
string
required

Update title. Plain text only.

description
string

Plain text or Markdown — never HTML.

type
string

Category ID. Optional.

segment
string

Segment ID. Restricts the update to a specific user segment for email + in-app announcements.

created
string<date>
default:now

Creation date. Past or future.

settings
object
draft
boolean
default:false
notify
boolean
default:true

Send email notifications to subscribers.

notify_delay
boolean
default:false

Bundle the day's updates into a digest sent the next morning at 10AM UTC.

announcement
boolean
default:false

Trigger in-app announcement popups.

Response

200 - application/json

OK

status
string
data
object