Skip to main content
PATCH
Update a video schedule

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string

A UUID. When present, deduplicates repeat submissions. See /api-reference/idempotency.

Path Parameters

id
string
required

Body

application/json
name
string
Required string length: 1 - 120
content_type
enum<string>

What each run makes: videos, or posts in post_formats. Default video.

Available options:
video,
post
post_formats
enum<string>[]

post only: the formats a run may pick from, varied from run to run. Omit for text with one relevant photo found on the web (image), where the accounts take it.

Maximum array length: 3
Available options:
text,
image,
carousel
per_day
integer

Videos or posts made and posted on each posting day. Default 1.

Required range: 1 <= x <= 10
days_of_week
integer[]

0 = Sunday to 6 = Saturday. Omit or empty for every day.

Maximum array length: 7
Required range: 0 <= x <= 6
post_hour
integer

Hour of the day posts go out. Default 9.

Required range: 0 <= x <= 23
post_minute
integer

Minute past post_hour posts go out, e.g. 33 for 5:33pm. Default 0.

Required range: 0 <= x <= 59
time_zone
string

IANA time zone, e.g. America/New_York. Default: the time zone of the user the API key belongs to (Settings > Preferences).

Required string length: 1 - 64
starts_on
string | null

First posting day, YYYY-MM-DD. Omit to start at once.

Pattern: ^\d{4}-\d{2}-\d{2}$
ends_on
string | null

Last posting day. Omit or null to run until paused.

Pattern: ^\d{4}-\d{2}-\d{2}$
connection_ids
string<uuid>[]

Accounts every piece is posted to

Minimum array length: 1
Pattern: ^([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)$
direction
string | null

What the videos or posts should be about and achieve, in your words

Maximum string length: 2000
allowed_templates
enum<string>[]

video only: templates Lincoln may pick from. Omit or empty for any it can make unattended but freeform_ai, which is billed per generated second. Every piece gets a caption written for it.

Maximum array length: 10
Available options:
ai_videographer,
talking_avatar,
remotion,
site_demo,
freeform_ai,
meme_hook,
interview,
phone_mockup,
slideshow,
real_footage
language
enum<string>

The language every piece is made in, as a code: each script, voiceover, on-screen text, caption and hashtag is in it. Default en.

Available options:
en,
en-GB,
en-AU,
es,
es-ES,
fr,
fr-CA,
de,
it,
pt-BR,
pt,
nl,
pl,
sv,
da,
no,
fi,
cs,
el,
hu,
ro,
ru,
uk,
tr,
ar,
he,
hi,
zh,
zh-Hant,
zh-TW,
zh-Hans-TW,
yue,
yue-Hans,
ja,
ko,
id,
ms,
fil,
vi,
th
notify_by_email
boolean

Email the API key's user as each run starts. Default true.

video_settings
object

video only: recipe parts pinned for every video: presenter, voice, style, format, length, source.

status
enum<string>

Pause or resume the schedule

Available options:
active,
paused

Response

Success

data
object
required