Skip to main content
POST
Create dashboard notification

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

FlowClient Credentials
Token URL
https://console.vantage.sh/account/profile
Scopes1
write
Grants write access

Body

application/json

Create a DashboardNotification.

title
string
required

The title of the DashboardNotification.

dashboard_token
string
required

The Dashboard token.

frequency
enum<string>
required

The frequency the DashboardNotification is sent. Possible values: daily, weekly, monthly.

Available options:
daily,
weekly,
monthly
workspace_token
string

The token of the Workspace to add the DashboardNotification to. Required if the API token is associated with multiple Workspaces.

user_tokens
string[]

The Users that receive the notification.

recipient_emails
string[]

Email addresses that receive the notification. Must be organization users, on the account's SSO domain, or an approved third-party service address.

Response

DashboardNotification model

token
string
required
title
string
required

The title of the DashboardNotification.

Example:

"Weekly Executive Dashboard"

dashboard_token
string
required

The token for the Dashboard the DashboardNotification sends.

Example:

"dshbrd_abcd1234"

workspace_token
string
required

The token for the Workspace the DashboardNotification is a part of.

Example:

"wrkspc_abcd1234567890"

user_tokens
string[]
required

The tokens of organization users that receive the notification. Freeform SSO-domain and approved third-party emails are not included; see recipient_emails.

recipient_emails
string[]
required

The email addresses that receive the notification, including organization users, SSO-domain addresses, and approved third-party addresses.

frequency
enum<string>
required

The frequency the DashboardNotification is sent.

Available options:
daily,
weekly,
monthly
Example:

"weekly"