API Reference

⌘
K
docs
API Reference
Introduction
Getting started
Language Specific SDKs
Authorization
Metering Cloud
Meter Definition
Ingest Meters
Custom Ingest Schema
Filtering Out Reported Meters
Querying Reported Usage
Querying Raw Events
Periodic Usage Reports
Billing Cloud
Account
Product Items
Product Item Price Templates
Queries
Pricing Plans
Invoices
Prepaid Orders
Prepaid Cards
Prepaid Wallet
Customer Promotions
Defining Promotions
Customer Commitment
Billing Analysis
Tax Calculation
Customers
Alerts and Webhooks
Notifications (Alerts)
Webhooks
Event Logs
Account Settings
Customer Portal
Session
Usage
Cost
Billing
Prepaid
Notifications
Meters
Usage Events
Pricing Plan
Setup Intent
Payment Method
Settings
Company Logo
Customer Details
Credits Ledger
Rewards History
Docs powered by Archbee
Customer Portal
Notifications

Update a notification

1min
PUT
https://app.amberflo.io/customer-portal/notification
Authentication
x-api-key
apiKey
Body Parameters
body
notification-put-request
All Of
object +
id
string
*
name
string
*
description
string
notificationType
string<usage | invoice | prepaid | product-item-units | product-item-price | undefined-meter | undefined-customer>
meterId
string
cron
string
frequency
string
webhookUrl
string
webhookHeaders
string
webhookPayload
string
email
string[]
customSubject
string
thresholdCondition
string<less-than | greater-than | equals | percent-change | always-true | less-than-percent | greater-than-percent>
thresholdValue
number
range
string<hour | day | week | month>
productPlanId
string
enabled
boolean
Responses
200
Successful response
notification-response
All Of
notification-put-request +
id
string
*
name
string
*
description
string
notificationType
string<usage | invoice | prepaid | product-item-units | product-item-price | undefined-meter | undefined-customer>
meterId
string
cron
string
frequency
string
webhookUrl
string
webhookHeaders
string
webhookPayload
string
email
string[]
customSubject
string
thresholdCondition
string<less-than | greater-than | equals | percent-change | always-true | less-than-percent | greater-than-percent>
thresholdValue
number
range
string<hour | day | week | month>
productPlanId
string
enabled
boolean
createTime
integer
updateTime
integer




Updated 30 Sep 2024
Doc contributor
Did this page help you?
PREVIOUS
Create a notification alert for the customer
NEXT
Get a list of notifications for the customer
Docs powered by Archbee