Skip to main content
PATCH
Change a usage alert
An absent field stays, even when another change lands at the same time; recipients replaces both its lists, and only recipients you send are checked. The change is recorded in your team’s audit log.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

alert_id
string
required

a usage alert ID: ual_ and 32 lowercase hex digits

Example:

"ual_0f8e2d1c4b3a49e8a7f6e5d4c3b2a190"

Body

application/json
trigger
object

What sets it off: calls or included_calls_percent each UTC day, overage or budget_percent (dollars, Owners and Admins only) each billing period, or cap_reached when the daily cap refuses runs

recipients
object

Replaces both lists; an absent list is emptied

on
boolean

Response

The alert

id
string
required
trigger
object
required

What sets it off: calls or included_calls_percent each UTC day, overage or budget_percent (dollars, Owners and Admins only) each billing period, or cap_reached when the daily cap refuses runs

window
enum<string>
required

It is emailed at most once in each: a UTC day, or a billing period

Available options:
day,
billing_period
on
boolean
required
recipients
object
required
on_changed_at
string
required

When it was created, or last turned on or off

last_sent_at
string | null
required

ISO 8601 UTC