Skip to content

Archive Schedule

PATCH
/schedules/{schedule_id}/archive

Archive or UN-archive a schedule (is_archived is explicit).

Archived schedules drop out of GET /schedules unless include_archived is set. Nothing is deleted.

Authorizations

Parameters

Path Parameters

schedule_id
required

Schedule id, from GET /schedules.

string

Schedule id, from GET /schedules.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Archive or UN-archive.

An explicit flag rather than a toggle, so a retried request is idempotent instead of flipping the state back - and it is what makes the same route the un-archive route.

object
is_archived
required
boolean

Responses

200

Successful Response

object
data
required

An open envelope around one sequencer record.

Open because templates, schedules and channels carry nested step data and configuration that grows as channels are added.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string