Skip to main content
PUT
Update a budget alert

Authorizations

Authorization
string
header
required

Send Authorization: Bearer <credential> using either a Clerk session JWT or a Clerk API key (ak_*). API keys may identify a user (user_*) or organization (org_*) principal and are generated in the Clerk Dashboard under API keys.

Path Parameters

budgetAlertId
string
required

Body

application/json
name
string
required
Minimum string length: 1
parentBudgetId
string
required
selectedVirtualDimensionValues
string[]
required
Minimum array length: 1
thresholds
object[]
required
Required array length: 1 - 3 elements
notification
object
required
conditionType
enum<string>
default:ACTUAL_SPEND
Available options:
ACTUAL_SPEND,
FORECASTED_EOM

Response

Budget alert updated

id
string
required
organizationId
string
required
createdAt
string<date-time> | null
required
createdById
string
required
archivedAt
string<date-time> | null
required
snoozedUntil
string<date-time> | null
required
name
string
required
selectedVirtualDimensionValues
string[]
required
notificationChannel
enum<string>
required
Available options:
EMAIL,
SLACK,
TEAMS
emails
string<email>[]
required
shouldNotifyLineOwners
boolean
required
slackChannelId
string | null
required
teamsChannelId
string | null
required
conditionType
enum<string>
required
Available options:
ACTUAL_SPEND,
FORECASTED_EOM
parentBudgetId
string
required
Last modified on August 10, 2026