Reschedule or edit a scheduled message
curl --request PATCH \
--url https://api.lithoblocks.com/v1/scheduled-messages/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"data": {},
"destination": {
"channel_id": "<string>"
},
"recurrence": {
"interval_minutes": 1,
"max_repeats": 1,
"end_at": "2023-11-07T05:31:56Z"
},
"delivery_conditions": {
"conditions": [],
"max_delay_minutes": 1
},
"follow_live": true,
"expiration": {
"after_seconds": 15811230,
"at": "2023-11-07T05:31:56Z",
"mode": "replace",
"retain_content": false
}
}
'import requests
url = "https://api.lithoblocks.com/v1/scheduled-messages/{id}"
payload = {
"data": {},
"destination": { "channel_id": "<string>" },
"recurrence": {
"interval_minutes": 1,
"max_repeats": 1,
"end_at": "2023-11-07T05:31:56Z"
},
"delivery_conditions": {
"conditions": [],
"max_delay_minutes": 1
},
"follow_live": True,
"expiration": {
"after_seconds": 15811230,
"at": "2023-11-07T05:31:56Z",
"mode": "replace",
"retain_content": False
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
data: {},
destination: {channel_id: '<string>'},
recurrence: {interval_minutes: 1, max_repeats: 1, end_at: '2023-11-07T05:31:56Z'},
delivery_conditions: {conditions: [], max_delay_minutes: 1},
follow_live: true,
expiration: {
after_seconds: 15811230,
at: '2023-11-07T05:31:56Z',
mode: 'replace',
retain_content: false
}
})
};
fetch('https://api.lithoblocks.com/v1/scheduled-messages/{id}', 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.lithoblocks.com/v1/scheduled-messages/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'data' => [
],
'destination' => [
'channel_id' => '<string>'
],
'recurrence' => [
'interval_minutes' => 1,
'max_repeats' => 1,
'end_at' => '2023-11-07T05:31:56Z'
],
'delivery_conditions' => [
'conditions' => [
],
'max_delay_minutes' => 1
],
'follow_live' => true,
'expiration' => [
'after_seconds' => 15811230,
'at' => '2023-11-07T05:31:56Z',
'mode' => 'replace',
'retain_content' => 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.lithoblocks.com/v1/scheduled-messages/{id}"
payload := strings.NewReader("{\n \"data\": {},\n \"destination\": {\n \"channel_id\": \"<string>\"\n },\n \"recurrence\": {\n \"interval_minutes\": 1,\n \"max_repeats\": 1,\n \"end_at\": \"2023-11-07T05:31:56Z\"\n },\n \"delivery_conditions\": {\n \"conditions\": [],\n \"max_delay_minutes\": 1\n },\n \"follow_live\": true,\n \"expiration\": {\n \"after_seconds\": 15811230,\n \"at\": \"2023-11-07T05:31:56Z\",\n \"mode\": \"replace\",\n \"retain_content\": false\n }\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.lithoblocks.com/v1/scheduled-messages/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"data\": {},\n \"destination\": {\n \"channel_id\": \"<string>\"\n },\n \"recurrence\": {\n \"interval_minutes\": 1,\n \"max_repeats\": 1,\n \"end_at\": \"2023-11-07T05:31:56Z\"\n },\n \"delivery_conditions\": {\n \"conditions\": [],\n \"max_delay_minutes\": 1\n },\n \"follow_live\": true,\n \"expiration\": {\n \"after_seconds\": 15811230,\n \"at\": \"2023-11-07T05:31:56Z\",\n \"mode\": \"replace\",\n \"retain_content\": false\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.lithoblocks.com/v1/scheduled-messages/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": {},\n \"destination\": {\n \"channel_id\": \"<string>\"\n },\n \"recurrence\": {\n \"interval_minutes\": 1,\n \"max_repeats\": 1,\n \"end_at\": \"2023-11-07T05:31:56Z\"\n },\n \"delivery_conditions\": {\n \"conditions\": [],\n \"max_delay_minutes\": 1\n },\n \"follow_live\": true,\n \"expiration\": {\n \"after_seconds\": 15811230,\n \"at\": \"2023-11-07T05:31:56Z\",\n \"mode\": \"replace\",\n \"retain_content\": false\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"status": "scheduled",
"template_id": "<string>",
"template_version_id": "<string>",
"queue_policy_id": "<string>",
"destination": {
"channel_id": "<string>"
},
"data": {},
"schedule": {
"send_at": "2023-11-07T05:31:56Z",
"timezone": "<string>"
},
"recurrence": {
"interval_minutes": 1,
"max_repeats": 1,
"end_at": "2023-11-07T05:31:56Z"
},
"repeat_count": 123,
"delivery_conditions": {
"conditions": [],
"max_delay_minutes": 1,
"on_miss": "send"
},
"max_delay_at": "<string>",
"expiration": {
"mode": "replace",
"retain_content": true,
"after_seconds": 123,
"at": "<string>"
},
"source": "<string>",
"error_message": "<string>",
"created_at": "<string>",
"processed_at": "<string>"
}{
"error": "<string>",
"code": "unauthenticated",
"request_id": "<string>",
"message": "<string>",
"details": "<string>",
"error_details": "<string>",
"success": false,
"valid": false,
"required_scopes": [
"<string>"
],
"user_scopes": [
"<string>"
]
}{
"error": "<string>",
"code": "unauthenticated",
"request_id": "<string>",
"message": "<string>",
"details": "<string>",
"error_details": "<string>",
"success": false,
"valid": false,
"required_scopes": [
"<string>"
],
"user_scopes": [
"<string>"
]
}{
"error": "<string>",
"code": "unauthenticated",
"request_id": "<string>",
"message": "<string>",
"details": "<string>",
"error_details": "<string>",
"success": false,
"valid": false,
"required_scopes": [
"<string>"
],
"user_scopes": [
"<string>"
]
}{
"error": "<string>",
"code": "unauthenticated",
"request_id": "<string>",
"message": "<string>",
"details": "<string>",
"error_details": "<string>",
"success": false,
"valid": false,
"required_scopes": [
"<string>"
],
"user_scopes": [
"<string>"
]
}{
"error": "<string>",
"code": "unauthenticated",
"request_id": "<string>",
"message": "<string>",
"details": "<string>",
"error_details": "<string>",
"success": false,
"valid": false,
"required_scopes": [
"<string>"
],
"user_scopes": [
"<string>"
]
}{
"success": false,
"error": {
"issues": [
{
"code": "<string>",
"path": [
"<string>"
],
"message": "<string>"
}
],
"name": "<string>"
},
"message": "<string>",
"code": "validation_failed",
"request_id": "<string>"
}{
"error": "<string>",
"code": "unauthenticated",
"request_id": "<string>",
"message": "<string>",
"details": "<string>",
"error_details": "<string>",
"success": false,
"valid": false,
"required_scopes": [
"<string>"
],
"user_scopes": [
"<string>"
]
}Scheduled messages
Reschedule or edit a scheduled message
Only while status is scheduled; anything later answers 409 (invalid_state).
Reschedule or edit a scheduled message
curl --request PATCH \
--url https://api.lithoblocks.com/v1/scheduled-messages/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"data": {},
"destination": {
"channel_id": "<string>"
},
"recurrence": {
"interval_minutes": 1,
"max_repeats": 1,
"end_at": "2023-11-07T05:31:56Z"
},
"delivery_conditions": {
"conditions": [],
"max_delay_minutes": 1
},
"follow_live": true,
"expiration": {
"after_seconds": 15811230,
"at": "2023-11-07T05:31:56Z",
"mode": "replace",
"retain_content": false
}
}
'import requests
url = "https://api.lithoblocks.com/v1/scheduled-messages/{id}"
payload = {
"data": {},
"destination": { "channel_id": "<string>" },
"recurrence": {
"interval_minutes": 1,
"max_repeats": 1,
"end_at": "2023-11-07T05:31:56Z"
},
"delivery_conditions": {
"conditions": [],
"max_delay_minutes": 1
},
"follow_live": True,
"expiration": {
"after_seconds": 15811230,
"at": "2023-11-07T05:31:56Z",
"mode": "replace",
"retain_content": False
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
data: {},
destination: {channel_id: '<string>'},
recurrence: {interval_minutes: 1, max_repeats: 1, end_at: '2023-11-07T05:31:56Z'},
delivery_conditions: {conditions: [], max_delay_minutes: 1},
follow_live: true,
expiration: {
after_seconds: 15811230,
at: '2023-11-07T05:31:56Z',
mode: 'replace',
retain_content: false
}
})
};
fetch('https://api.lithoblocks.com/v1/scheduled-messages/{id}', 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.lithoblocks.com/v1/scheduled-messages/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'data' => [
],
'destination' => [
'channel_id' => '<string>'
],
'recurrence' => [
'interval_minutes' => 1,
'max_repeats' => 1,
'end_at' => '2023-11-07T05:31:56Z'
],
'delivery_conditions' => [
'conditions' => [
],
'max_delay_minutes' => 1
],
'follow_live' => true,
'expiration' => [
'after_seconds' => 15811230,
'at' => '2023-11-07T05:31:56Z',
'mode' => 'replace',
'retain_content' => 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.lithoblocks.com/v1/scheduled-messages/{id}"
payload := strings.NewReader("{\n \"data\": {},\n \"destination\": {\n \"channel_id\": \"<string>\"\n },\n \"recurrence\": {\n \"interval_minutes\": 1,\n \"max_repeats\": 1,\n \"end_at\": \"2023-11-07T05:31:56Z\"\n },\n \"delivery_conditions\": {\n \"conditions\": [],\n \"max_delay_minutes\": 1\n },\n \"follow_live\": true,\n \"expiration\": {\n \"after_seconds\": 15811230,\n \"at\": \"2023-11-07T05:31:56Z\",\n \"mode\": \"replace\",\n \"retain_content\": false\n }\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.lithoblocks.com/v1/scheduled-messages/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"data\": {},\n \"destination\": {\n \"channel_id\": \"<string>\"\n },\n \"recurrence\": {\n \"interval_minutes\": 1,\n \"max_repeats\": 1,\n \"end_at\": \"2023-11-07T05:31:56Z\"\n },\n \"delivery_conditions\": {\n \"conditions\": [],\n \"max_delay_minutes\": 1\n },\n \"follow_live\": true,\n \"expiration\": {\n \"after_seconds\": 15811230,\n \"at\": \"2023-11-07T05:31:56Z\",\n \"mode\": \"replace\",\n \"retain_content\": false\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.lithoblocks.com/v1/scheduled-messages/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": {},\n \"destination\": {\n \"channel_id\": \"<string>\"\n },\n \"recurrence\": {\n \"interval_minutes\": 1,\n \"max_repeats\": 1,\n \"end_at\": \"2023-11-07T05:31:56Z\"\n },\n \"delivery_conditions\": {\n \"conditions\": [],\n \"max_delay_minutes\": 1\n },\n \"follow_live\": true,\n \"expiration\": {\n \"after_seconds\": 15811230,\n \"at\": \"2023-11-07T05:31:56Z\",\n \"mode\": \"replace\",\n \"retain_content\": false\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"status": "scheduled",
"template_id": "<string>",
"template_version_id": "<string>",
"queue_policy_id": "<string>",
"destination": {
"channel_id": "<string>"
},
"data": {},
"schedule": {
"send_at": "2023-11-07T05:31:56Z",
"timezone": "<string>"
},
"recurrence": {
"interval_minutes": 1,
"max_repeats": 1,
"end_at": "2023-11-07T05:31:56Z"
},
"repeat_count": 123,
"delivery_conditions": {
"conditions": [],
"max_delay_minutes": 1,
"on_miss": "send"
},
"max_delay_at": "<string>",
"expiration": {
"mode": "replace",
"retain_content": true,
"after_seconds": 123,
"at": "<string>"
},
"source": "<string>",
"error_message": "<string>",
"created_at": "<string>",
"processed_at": "<string>"
}{
"error": "<string>",
"code": "unauthenticated",
"request_id": "<string>",
"message": "<string>",
"details": "<string>",
"error_details": "<string>",
"success": false,
"valid": false,
"required_scopes": [
"<string>"
],
"user_scopes": [
"<string>"
]
}{
"error": "<string>",
"code": "unauthenticated",
"request_id": "<string>",
"message": "<string>",
"details": "<string>",
"error_details": "<string>",
"success": false,
"valid": false,
"required_scopes": [
"<string>"
],
"user_scopes": [
"<string>"
]
}{
"error": "<string>",
"code": "unauthenticated",
"request_id": "<string>",
"message": "<string>",
"details": "<string>",
"error_details": "<string>",
"success": false,
"valid": false,
"required_scopes": [
"<string>"
],
"user_scopes": [
"<string>"
]
}{
"error": "<string>",
"code": "unauthenticated",
"request_id": "<string>",
"message": "<string>",
"details": "<string>",
"error_details": "<string>",
"success": false,
"valid": false,
"required_scopes": [
"<string>"
],
"user_scopes": [
"<string>"
]
}{
"error": "<string>",
"code": "unauthenticated",
"request_id": "<string>",
"message": "<string>",
"details": "<string>",
"error_details": "<string>",
"success": false,
"valid": false,
"required_scopes": [
"<string>"
],
"user_scopes": [
"<string>"
]
}{
"success": false,
"error": {
"issues": [
{
"code": "<string>",
"path": [
"<string>"
],
"message": "<string>"
}
],
"name": "<string>"
},
"message": "<string>",
"code": "validation_failed",
"request_id": "<string>"
}{
"error": "<string>",
"code": "unauthenticated",
"request_id": "<string>",
"message": "<string>",
"details": "<string>",
"error_details": "<string>",
"success": false,
"valid": false,
"required_scopes": [
"<string>"
],
"user_scopes": [
"<string>"
]
}Authorizations
LithoBlocks API key obtained from your organization dashboard. The LithoBlocks MCP server also presents a Supabase-issued user session token here on the user's behalf; such a token acts as that user with the scopes their organization role allows.
Path Parameters
Body
application/json
Fields to change
Show child attributes
Show child attributes
- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
Show child attributes
Show child attributes
null removes the recurrence
Show child attributes
Show child attributes
null removes the conditions
Show child attributes
Show child attributes
true removes the pin, so the message sends whatever version is live at send time. false pins it to the version live now (re-pin). Omitted, the pin is unchanged
Expire the message: replace it with a notice, or delete it. Precise to about a minute; a button clicked after the deadline does nothing even before the message is replaced.
Show child attributes
Show child attributes
Response
Updated
Available options:
scheduled, processing, sent, failed, cancelled, expired The version this message is pinned to. null sends whatever version is live when it sends (follow_live); a legacy policy-driven message with no pin of its own uses its policy's
Set on legacy policy-driven messages only
- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The schedule's own expiry for each message it sends; the template's default and maximum apply too
Show child attributes
Show child attributes