API Reference

/budget_alerts/{budget_alert_token}

Updates an existing BudgetAlert.

Log in to see full request history
timestatususer agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Form Data
array of strings

The tokens of the Budget that has the alert.

budget_tokens
int32

The threshold amount that must be met for the alert to fire.

array of strings

The tokens of the users that receive the alert.

user_tokens
int32

The number of days from the start or end of the month to trigger the alert if the threshold is reached. For the full month, pass an empty value.

string

The period tracked on the alert. Used with duration_in_days to determine the time window of the alert. Defaults to start_of_the_month if not passed. Possible values: start_of_the_month, end_of_the_month.

array of strings

The channels receiving the alerts. Requires an integration provider to be connected.

recipient_channels
Responses

Language
Credentials
OAuth2
Click Try It! to start a request and see the response here! Or choose an example:
application/json