Skip to main content
POST
/
update
Create a changelog update
curl --request POST \
  --url https://api.sleekplan.com/v1/update \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "description": "<string>",
  "type": "<string>",
  "segment": "<string>",
  "created": "now",
  "settings": {
    "link": "<string>",
    "link_text": "<string>",
    "link_color": "<string>"
  },
  "draft": false,
  "notify": true,
  "notify_delay": false,
  "announcement": false
}
'
{
  "status": "<string>",
  "data": {
    "changelog_id": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://sleekplan.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

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