Skip to main content
PATCH
Update a folder archive snapshot schedule

Authorizations

Authorization
string
header
required

Dashboard-generated Convertly API key. Keys currently begin with cvly_.

Path Parameters

id
string<uuid>
required

Body

application/json
name
string
Maximum string length: 120
enabled
boolean
frequency
enum<string>
Available options:
daily,
weekly,
monthly
hour
integer
Required range: 0 <= x <= 23
minute
integer
Required range: 0 <= x <= 59
dayOfWeek
integer
Required range: 0 <= x <= 6
dayOfMonth
integer
Required range: 1 <= x <= 28
timezone
string
format
enum<string>
Available options:
zip,
tar,
tgz
targetFolderId
string<uuid> | null
retentionCount
integer | null
Required range: 1 <= x <= 365
retentionDays
integer | null
Required range: 1 <= x <= 3650

Response

Schedule updated

Last modified on July 31, 2026