<budget_name>!SET_NOTIFICATION_MUTE_FLAG

Enable or disable notifications for a budget.

See also:

<budget_name>!GET_NOTIFICATION_EMAIL, <budget_name>!GET_NOTIFICATION_INTEGRATION_NAME, <budget_name>!GET_NOTIFICATION_MUTE_FLAG, <budget_name>!SET_EMAIL_NOTIFICATIONS

Syntax

<budget_name>!SET_NOTIFICATION_MUTE_FLAG( { TRUE | FALSE } );
Copy

Arguments

{ TRUE | FALSE }
  • TRUE to disable notifications.

  • FALSE to enable notifications.

Default: FALSE

Returns

The notification mute flag has been updated to <true | false>.

Access control requirements

  • The following minimum privileges and roles are required to call this method for custom budgets:

    • Any instance role for the budget instance.

    • USAGE privilege on the database and schema that contains the budget instance.

  • The following minimum privileges and roles are required to call this method for the account budget:

    Any application role for the account budget.

For more information, see Budgets roles and privileges.

Usage notes

Calling this method does not return the object. Because of this, you can’t use method chaining to call another method on the return value of this method. Instead, call each method in a separate SQL statement.

Examples

Disable notifications for budget my_budget in schema budget_db.budget_schema:

CALL budget_db.budget_schema.my_budget!SET_NOTIFICATION_MUTE_FLAG(TRUE);
Copy

Enable notifications for the account budget:

CALL snowflake.local.account_root_budget!SET_NOTIFICATION_MUTE_FLAG(FALSE);
Copy