Create a resource subscription

Create an email subscription for automated delivery of reports or dashboards. Subscriptions send scheduled emails at the specified frequency.

Frequency options: DAILY, WEEKLY, MONTHLY

For weekly subscriptions, specify dayOfWeek. For monthly subscriptions, specify both dayOfWeek and weekOfMonth.

See Reports for more details.

Schedule fields are evaluated in UTC. Delivery needs dayOfWeek for weekly schedules and both dayOfWeek and weekOfMonth (FIRST or LAST occurrence of that weekday) for monthly schedules. The API accepts schedules missing these fields, but they never match a delivery schedule. hourOfDay is a UTC hour, not a timezone-aware local-time schedule.

Body Params
uuid
required
^([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)$

Dashboard ID. Required if creating a Dashboard Subscription.

string
enum
required
Allowed:
uuid
required
^([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)$

Unique identifier for an organization

uuid
^([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)$

Report ID. Required if creating a Report Subscription.

emails
array of strings
required
length ≥ 1

Subscription emails

emails*
string
enum
required

Report frequency

Allowed:
string
enum
required

Report delivery hour

string
enum

Report delivery day

Allowed:
slackChannelIDs
array of strings

Slack channel IDs to send notifications to

slackChannelIDs
string
enum

Report delivery week of the month

Allowed:
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json