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
}
'import requests
url = "https://api.sleekplan.com/v1/update"
payload = {
"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
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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
})
};
fetch('https://api.sleekplan.com/v1/update', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sleekplan.com/v1/update",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sleekplan.com/v1/update"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"type\": \"<string>\",\n \"segment\": \"<string>\",\n \"created\": \"now\",\n \"settings\": {\n \"link\": \"<string>\",\n \"link_text\": \"<string>\",\n \"link_color\": \"<string>\"\n },\n \"draft\": false,\n \"notify\": true,\n \"notify_delay\": false,\n \"announcement\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.sleekplan.com/v1/update")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"type\": \"<string>\",\n \"segment\": \"<string>\",\n \"created\": \"now\",\n \"settings\": {\n \"link\": \"<string>\",\n \"link_text\": \"<string>\",\n \"link_color\": \"<string>\"\n },\n \"draft\": false,\n \"notify\": true,\n \"notify_delay\": false,\n \"announcement\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sleekplan.com/v1/update")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"type\": \"<string>\",\n \"segment\": \"<string>\",\n \"created\": \"now\",\n \"settings\": {\n \"link\": \"<string>\",\n \"link_text\": \"<string>\",\n \"link_color\": \"<string>\"\n },\n \"draft\": false,\n \"notify\": true,\n \"notify_delay\": false,\n \"announcement\": false\n}"
response = http.request(request)
puts response.read_body{
"status": "<string>",
"data": {
"changelog_id": 123
}
}Update
Create a changelog update
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
}
'import requests
url = "https://api.sleekplan.com/v1/update"
payload = {
"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
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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
})
};
fetch('https://api.sleekplan.com/v1/update', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sleekplan.com/v1/update",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sleekplan.com/v1/update"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"type\": \"<string>\",\n \"segment\": \"<string>\",\n \"created\": \"now\",\n \"settings\": {\n \"link\": \"<string>\",\n \"link_text\": \"<string>\",\n \"link_color\": \"<string>\"\n },\n \"draft\": false,\n \"notify\": true,\n \"notify_delay\": false,\n \"announcement\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.sleekplan.com/v1/update")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"type\": \"<string>\",\n \"segment\": \"<string>\",\n \"created\": \"now\",\n \"settings\": {\n \"link\": \"<string>\",\n \"link_text\": \"<string>\",\n \"link_color\": \"<string>\"\n },\n \"draft\": false,\n \"notify\": true,\n \"notify_delay\": false,\n \"announcement\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sleekplan.com/v1/update")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"type\": \"<string>\",\n \"segment\": \"<string>\",\n \"created\": \"now\",\n \"settings\": {\n \"link\": \"<string>\",\n \"link_text\": \"<string>\",\n \"link_color\": \"<string>\"\n },\n \"draft\": false,\n \"notify\": true,\n \"notify_delay\": false,\n \"announcement\": false\n}"
response = http.request(request)
puts response.read_body{
"status": "<string>",
"data": {
"changelog_id": 123
}
}Authorizations
BearerAuthBasicAuthApiKeyQuery
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Update title. Plain text only.
Plain text or Markdown — never HTML.
Category ID. Optional.
Segment ID. Restricts the update to a specific user segment for email + in-app announcements.
Creation date. Past or future.
Show child attributes
Show child attributes
Send email notifications to subscribers.
Bundle the day's updates into a digest sent the next morning at 10AM UTC.
Trigger in-app announcement popups.
Was this page helpful?
⌘I
