Update a video schedule
curl --request PATCH \
--url https://api.lumisreach.com/api/v1/video-schedules/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"videos_per_day": 5,
"days_of_week": [
3
],
"post_hour": 11,
"time_zone": "<string>",
"starts_on": "<string>",
"ends_on": "<string>",
"connection_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"caption": "<string>",
"direction": "<string>",
"allowed_templates": [],
"notify_hours_before": 12,
"notify_by_email": true,
"video_settings": {
"source_url": "<string>",
"source_text": "<string>",
"preset": "<string>",
"avatar_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"replica_id": "<string>",
"voice_id": "<string>",
"video_model": "<string>"
}
}
'import requests
url = "https://api.lumisreach.com/api/v1/video-schedules/{id}"
payload = {
"name": "<string>",
"videos_per_day": 5,
"days_of_week": [3],
"post_hour": 11,
"time_zone": "<string>",
"starts_on": "<string>",
"ends_on": "<string>",
"connection_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"caption": "<string>",
"direction": "<string>",
"allowed_templates": [],
"notify_hours_before": 12,
"notify_by_email": True,
"video_settings": {
"source_url": "<string>",
"source_text": "<string>",
"preset": "<string>",
"avatar_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"replica_id": "<string>",
"voice_id": "<string>",
"video_model": "<string>"
}
}
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({
name: '<string>',
videos_per_day: 5,
days_of_week: [3],
post_hour: 11,
time_zone: '<string>',
starts_on: '<string>',
ends_on: '<string>',
connection_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
caption: '<string>',
direction: '<string>',
allowed_templates: [],
notify_hours_before: 12,
notify_by_email: true,
video_settings: {
source_url: '<string>',
source_text: '<string>',
preset: '<string>',
avatar_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
replica_id: '<string>',
voice_id: '<string>',
video_model: '<string>'
}
})
};
fetch('https://api.lumisreach.com/api/v1/video-schedules/{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.lumisreach.com/api/v1/video-schedules/{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([
'name' => '<string>',
'videos_per_day' => 5,
'days_of_week' => [
3
],
'post_hour' => 11,
'time_zone' => '<string>',
'starts_on' => '<string>',
'ends_on' => '<string>',
'connection_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'caption' => '<string>',
'direction' => '<string>',
'allowed_templates' => [
],
'notify_hours_before' => 12,
'notify_by_email' => true,
'video_settings' => [
'source_url' => '<string>',
'source_text' => '<string>',
'preset' => '<string>',
'avatar_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'replica_id' => '<string>',
'voice_id' => '<string>',
'video_model' => '<string>'
]
]),
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.lumisreach.com/api/v1/video-schedules/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"videos_per_day\": 5,\n \"days_of_week\": [\n 3\n ],\n \"post_hour\": 11,\n \"time_zone\": \"<string>\",\n \"starts_on\": \"<string>\",\n \"ends_on\": \"<string>\",\n \"connection_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"caption\": \"<string>\",\n \"direction\": \"<string>\",\n \"allowed_templates\": [],\n \"notify_hours_before\": 12,\n \"notify_by_email\": true,\n \"video_settings\": {\n \"source_url\": \"<string>\",\n \"source_text\": \"<string>\",\n \"preset\": \"<string>\",\n \"avatar_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"replica_id\": \"<string>\",\n \"voice_id\": \"<string>\",\n \"video_model\": \"<string>\"\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.lumisreach.com/api/v1/video-schedules/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"videos_per_day\": 5,\n \"days_of_week\": [\n 3\n ],\n \"post_hour\": 11,\n \"time_zone\": \"<string>\",\n \"starts_on\": \"<string>\",\n \"ends_on\": \"<string>\",\n \"connection_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"caption\": \"<string>\",\n \"direction\": \"<string>\",\n \"allowed_templates\": [],\n \"notify_hours_before\": 12,\n \"notify_by_email\": true,\n \"video_settings\": {\n \"source_url\": \"<string>\",\n \"source_text\": \"<string>\",\n \"preset\": \"<string>\",\n \"avatar_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"replica_id\": \"<string>\",\n \"voice_id\": \"<string>\",\n \"video_model\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.lumisreach.com/api/v1/video-schedules/{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 \"name\": \"<string>\",\n \"videos_per_day\": 5,\n \"days_of_week\": [\n 3\n ],\n \"post_hour\": 11,\n \"time_zone\": \"<string>\",\n \"starts_on\": \"<string>\",\n \"ends_on\": \"<string>\",\n \"connection_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"caption\": \"<string>\",\n \"direction\": \"<string>\",\n \"allowed_templates\": [],\n \"notify_hours_before\": 12,\n \"notify_by_email\": true,\n \"video_settings\": {\n \"source_url\": \"<string>\",\n \"source_text\": \"<string>\",\n \"preset\": \"<string>\",\n \"avatar_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"replica_id\": \"<string>\",\n \"voice_id\": \"<string>\",\n \"video_model\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "active",
"cadence": "<string>",
"videos_per_day": 0,
"days_of_week": [
0
],
"post_hour": 0,
"time_zone": "<string>",
"starts_on": "<string>",
"ends_on": "<string>",
"skip_dates": [
"<string>"
],
"notify_hours_before": 0,
"notify_by_email": true,
"connection_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"caption": "<string>",
"direction": "<string>",
"allowed_templates": [
"<string>"
],
"video_settings": {
"format": "vertical",
"target_duration_seconds": 10,
"source_url": "<string>",
"source_text": "<string>",
"preset": "<string>",
"avatar_provider": "heygen",
"avatar_layout": "center",
"avatar_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"replica_id": "<string>",
"voice_id": "<string>",
"video_model": "<string>",
"subtitle_style": "none",
"subtitle_position": "top",
"subtitle_size": "small"
},
"source_video_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"next_run": {
"day": "<string>",
"post_at": "2023-11-07T05:31:56Z",
"plan_at": "2023-11-07T05:31:56Z"
},
"last_run_on": "<string>",
"last_error": "<string>",
"estimated_price_cents_per_video": 0,
"estimate_depends_on_template": true,
"created_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"fields": {},
"doc_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"fields": {},
"doc_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"fields": {},
"doc_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"fields": {},
"doc_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"fields": {},
"doc_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"fields": {},
"doc_url": "<string>"
}
}Video Schedules
Update a video schedule
Change any of a schedule’s fields; the ones you leave out stay as they are. video_settings is merged over the pinned recipe. Pause with status: paused and resume with status: active. Free.
PATCH
/
v1
/
video-schedules
/
{id}
Update a video schedule
curl --request PATCH \
--url https://api.lumisreach.com/api/v1/video-schedules/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"videos_per_day": 5,
"days_of_week": [
3
],
"post_hour": 11,
"time_zone": "<string>",
"starts_on": "<string>",
"ends_on": "<string>",
"connection_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"caption": "<string>",
"direction": "<string>",
"allowed_templates": [],
"notify_hours_before": 12,
"notify_by_email": true,
"video_settings": {
"source_url": "<string>",
"source_text": "<string>",
"preset": "<string>",
"avatar_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"replica_id": "<string>",
"voice_id": "<string>",
"video_model": "<string>"
}
}
'import requests
url = "https://api.lumisreach.com/api/v1/video-schedules/{id}"
payload = {
"name": "<string>",
"videos_per_day": 5,
"days_of_week": [3],
"post_hour": 11,
"time_zone": "<string>",
"starts_on": "<string>",
"ends_on": "<string>",
"connection_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"caption": "<string>",
"direction": "<string>",
"allowed_templates": [],
"notify_hours_before": 12,
"notify_by_email": True,
"video_settings": {
"source_url": "<string>",
"source_text": "<string>",
"preset": "<string>",
"avatar_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"replica_id": "<string>",
"voice_id": "<string>",
"video_model": "<string>"
}
}
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({
name: '<string>',
videos_per_day: 5,
days_of_week: [3],
post_hour: 11,
time_zone: '<string>',
starts_on: '<string>',
ends_on: '<string>',
connection_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
caption: '<string>',
direction: '<string>',
allowed_templates: [],
notify_hours_before: 12,
notify_by_email: true,
video_settings: {
source_url: '<string>',
source_text: '<string>',
preset: '<string>',
avatar_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
replica_id: '<string>',
voice_id: '<string>',
video_model: '<string>'
}
})
};
fetch('https://api.lumisreach.com/api/v1/video-schedules/{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.lumisreach.com/api/v1/video-schedules/{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([
'name' => '<string>',
'videos_per_day' => 5,
'days_of_week' => [
3
],
'post_hour' => 11,
'time_zone' => '<string>',
'starts_on' => '<string>',
'ends_on' => '<string>',
'connection_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'caption' => '<string>',
'direction' => '<string>',
'allowed_templates' => [
],
'notify_hours_before' => 12,
'notify_by_email' => true,
'video_settings' => [
'source_url' => '<string>',
'source_text' => '<string>',
'preset' => '<string>',
'avatar_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'replica_id' => '<string>',
'voice_id' => '<string>',
'video_model' => '<string>'
]
]),
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.lumisreach.com/api/v1/video-schedules/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"videos_per_day\": 5,\n \"days_of_week\": [\n 3\n ],\n \"post_hour\": 11,\n \"time_zone\": \"<string>\",\n \"starts_on\": \"<string>\",\n \"ends_on\": \"<string>\",\n \"connection_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"caption\": \"<string>\",\n \"direction\": \"<string>\",\n \"allowed_templates\": [],\n \"notify_hours_before\": 12,\n \"notify_by_email\": true,\n \"video_settings\": {\n \"source_url\": \"<string>\",\n \"source_text\": \"<string>\",\n \"preset\": \"<string>\",\n \"avatar_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"replica_id\": \"<string>\",\n \"voice_id\": \"<string>\",\n \"video_model\": \"<string>\"\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.lumisreach.com/api/v1/video-schedules/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"videos_per_day\": 5,\n \"days_of_week\": [\n 3\n ],\n \"post_hour\": 11,\n \"time_zone\": \"<string>\",\n \"starts_on\": \"<string>\",\n \"ends_on\": \"<string>\",\n \"connection_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"caption\": \"<string>\",\n \"direction\": \"<string>\",\n \"allowed_templates\": [],\n \"notify_hours_before\": 12,\n \"notify_by_email\": true,\n \"video_settings\": {\n \"source_url\": \"<string>\",\n \"source_text\": \"<string>\",\n \"preset\": \"<string>\",\n \"avatar_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"replica_id\": \"<string>\",\n \"voice_id\": \"<string>\",\n \"video_model\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.lumisreach.com/api/v1/video-schedules/{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 \"name\": \"<string>\",\n \"videos_per_day\": 5,\n \"days_of_week\": [\n 3\n ],\n \"post_hour\": 11,\n \"time_zone\": \"<string>\",\n \"starts_on\": \"<string>\",\n \"ends_on\": \"<string>\",\n \"connection_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"caption\": \"<string>\",\n \"direction\": \"<string>\",\n \"allowed_templates\": [],\n \"notify_hours_before\": 12,\n \"notify_by_email\": true,\n \"video_settings\": {\n \"source_url\": \"<string>\",\n \"source_text\": \"<string>\",\n \"preset\": \"<string>\",\n \"avatar_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"replica_id\": \"<string>\",\n \"voice_id\": \"<string>\",\n \"video_model\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "active",
"cadence": "<string>",
"videos_per_day": 0,
"days_of_week": [
0
],
"post_hour": 0,
"time_zone": "<string>",
"starts_on": "<string>",
"ends_on": "<string>",
"skip_dates": [
"<string>"
],
"notify_hours_before": 0,
"notify_by_email": true,
"connection_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"caption": "<string>",
"direction": "<string>",
"allowed_templates": [
"<string>"
],
"video_settings": {
"format": "vertical",
"target_duration_seconds": 10,
"source_url": "<string>",
"source_text": "<string>",
"preset": "<string>",
"avatar_provider": "heygen",
"avatar_layout": "center",
"avatar_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"replica_id": "<string>",
"voice_id": "<string>",
"video_model": "<string>",
"subtitle_style": "none",
"subtitle_position": "top",
"subtitle_size": "small"
},
"source_video_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"next_run": {
"day": "<string>",
"post_at": "2023-11-07T05:31:56Z",
"plan_at": "2023-11-07T05:31:56Z"
},
"last_run_on": "<string>",
"last_error": "<string>",
"estimated_price_cents_per_video": 0,
"estimate_depends_on_template": true,
"created_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"fields": {},
"doc_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"fields": {},
"doc_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"fields": {},
"doc_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"fields": {},
"doc_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"fields": {},
"doc_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"fields": {},
"doc_url": "<string>"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
A UUID. When present, deduplicates repeat submissions. See /api-reference/idempotency.
Path Parameters
Body
application/json
Required string length:
1 - 120Required range:
1 <= x <= 100 = Sunday to 6 = Saturday. Omit or empty for every day.
Maximum array length:
7Required range:
0 <= x <= 6Hour of the day posts go out. Default 9.
Required range:
0 <= x <= 23IANA time zone, e.g. America/New_York. Default UTC.
Required string length:
1 - 64First posting day, YYYY-MM-DD
Pattern:
^\d{4}-\d{2}-\d{2}$Last posting day. Omit or null to run until paused.
Pattern:
^\d{4}-\d{2}-\d{2}$Accounts every video is posted to
Minimum array length:
1Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$One caption for every post. Omit to have one written per video.
Maximum string length:
4000What the videos should be about, in your words
Maximum string length:
2000Templates the director may pick from. Omit or empty for any it can make.
Maximum array length:
8Available options:
talking_avatar, remotion, freeform_ai, meme_hook, interview, phone_mockup, slideshow, real_footage How far ahead the videos are planned and you are told what is coming. Default 1.
Required range:
0 <= x <= 24Recipe parts pinned for every video: presenter, style, format, length, source.
Show child attributes
Show child attributes
Pause or resume the schedule
Available options:
active, paused Response
Success
Show child attributes
Show child attributes