Skip to content

Create Schedule

POST
/schedules

Create a sending schedule: a weekly set of windows in one timezone.

A day left out of config is a day nothing is sent. Put it on a sequence with PATCH /sequences/{id} (schedule_id).

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

A sending schedule. Mirrors CreateSchedulePayload minus the client id.

object
config
required

The weekly window. A day left out is a day nothing is sent.

object
friday
Any of:

One day’s sending window. start must be EARLIER than end.

Overnight windows are not supported - model them as two days. The app rejects an inverted or zero-length window, and so does this.

object
end
required

HH:MM, 24-hour.

string
/^([01]?[0-9]|2[0-3]):[0-5][0-9]$/
start
required

HH:MM, 24-hour.

string
/^([01]?[0-9]|2[0-3]):[0-5][0-9]$/
monday
Any of:

One day’s sending window. start must be EARLIER than end.

Overnight windows are not supported - model them as two days. The app rejects an inverted or zero-length window, and so does this.

object
end
required

HH:MM, 24-hour.

string
/^([01]?[0-9]|2[0-3]):[0-5][0-9]$/
start
required

HH:MM, 24-hour.

string
/^([01]?[0-9]|2[0-3]):[0-5][0-9]$/
saturday
Any of:

One day’s sending window. start must be EARLIER than end.

Overnight windows are not supported - model them as two days. The app rejects an inverted or zero-length window, and so does this.

object
end
required

HH:MM, 24-hour.

string
/^([01]?[0-9]|2[0-3]):[0-5][0-9]$/
start
required

HH:MM, 24-hour.

string
/^([01]?[0-9]|2[0-3]):[0-5][0-9]$/
sunday
Any of:

One day’s sending window. start must be EARLIER than end.

Overnight windows are not supported - model them as two days. The app rejects an inverted or zero-length window, and so does this.

object
end
required

HH:MM, 24-hour.

string
/^([01]?[0-9]|2[0-3]):[0-5][0-9]$/
start
required

HH:MM, 24-hour.

string
/^([01]?[0-9]|2[0-3]):[0-5][0-9]$/
thursday
Any of:

One day’s sending window. start must be EARLIER than end.

Overnight windows are not supported - model them as two days. The app rejects an inverted or zero-length window, and so does this.

object
end
required

HH:MM, 24-hour.

string
/^([01]?[0-9]|2[0-3]):[0-5][0-9]$/
start
required

HH:MM, 24-hour.

string
/^([01]?[0-9]|2[0-3]):[0-5][0-9]$/
tuesday
Any of:

One day’s sending window. start must be EARLIER than end.

Overnight windows are not supported - model them as two days. The app rejects an inverted or zero-length window, and so does this.

object
end
required

HH:MM, 24-hour.

string
/^([01]?[0-9]|2[0-3]):[0-5][0-9]$/
start
required

HH:MM, 24-hour.

string
/^([01]?[0-9]|2[0-3]):[0-5][0-9]$/
wednesday
Any of:

One day’s sending window. start must be EARLIER than end.

Overnight windows are not supported - model them as two days. The app rejects an inverted or zero-length window, and so does this.

object
end
required

HH:MM, 24-hour.

string
/^([01]?[0-9]|2[0-3]):[0-5][0-9]$/
start
required

HH:MM, 24-hour.

string
/^([01]?[0-9]|2[0-3]):[0-5][0-9]$/
description
Any of:
string
<= 1024 characters
name
required
string
<= 255 characters
timezone

IANA timezone.

string
default: UTC <= 128 characters

Responses

201

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