Skip to main content
PUT
cURL

Authorizations

Authorization
string
header
required

For your own scripts and server-to-server integrations. Create a key in the app under Settings > Access > API keys and copy it then, because it is shown once. Send it as Authorization: Bearer <key>. The key acts as the member who made it, in the organization it was made in. A call needs the member's permission and one of the key's scopes, such as inventory:read or sales:write. A key with * has every scope.

Path Parameters

schedule
string | null
required

Body

application/json

A scheduled report or an alert to save: what it sends or watches, when, to whom and how, and for an alert the condition and its quiet period.

kind
enum<string>
required

report sends a view or a dashboard on its schedule; alert watches a KPI or a view and mails when it crosses its condition.

Available options:
report,
alert
name
string
required

What it is called.

Maximum string length: 120
subject
enum<string>
required

view, dashboard or kpi: a report sends a view or a dashboard, an alert watches a view or a KPI.

Available options:
view,
dashboard,
kpi
subject_id
string<uuid>
required

The id of the view, dashboard or KPI.

frequency
enum<string>
required

daily, weekly, monthly or cron, in the organization's time zone.

Available options:
daily,
weekly,
monthly,
cron
at
string
required

The time of day, such as 08:00.

view_version
integer | null

The version of a view to send. It stays at that version until changed; the newest when left out.

Required range: x >= 1
weekday
integer | null

For weekly: 1 for Monday to 7 for Sunday.

Required range: 1 <= x <= 7
day
integer | null

For monthly: the day of the month, 1 to 28.

Required range: 1 <= x <= 28
cron
string | null

For cron: a five-field expression, such as 0 8 * * 1-5.

Maximum string length: 100
delivery
enum<string> | null

For a report: link, attachment or both.

Available options:
link,
attachment,
both
format
enum<string> | null

For a report: the file format, csv, xlsx, workbook or pdf.

Available options:
csv,
xlsx,
workbook,
pdf
users
integer[]

The ids of the members who receive it.

Maximum array length: 100
roles
string[]

The names of the roles whose members receive it.

Maximum array length: 50
Maximum string length: 255
operator
enum<string> | null

For an alert: above, below, rises, falls or status.

Available options:
above,
below,
rises,
falls,
status
value
string | null

For an alert: the limit, the percentage of a rise or fall, or for status, warning or bad.

Maximum string length: 32
Pattern: ^-?\d{1,18}(\.\d{1,12})?$
quiet_minutes
integer | null

For an alert: minutes after one alert in which it sends no other.

Required range: 0 <= x <= 10080

Response

ScheduleSavedResource

data
ScheduleSavedResource · object
required