Skip to main content
PUT
/
balance-monitors
/
{monitor_id}
Update balance monitor
curl --request PUT \
  --url http://localhost:5001/balance-monitors/{monitor_id} \
  --header 'X-blnk-key: <api-key>'
Use client.BalanceMonitor.Update to update a balance monitor.
1

Call the method

client.BalanceMonitor.Update
monitor, resp, err := client.BalanceMonitor.Update(
	"mon_e0e77b0c-4985-472a",
	blnkgo.MonitorData{
		BalanceID: "bln_5ce86029-3c2e-4e2a",
		Condition: blnkgo.MonitorCondition{
			Field: "credit_balance",
			Operator: blnkgo.OperatorLessThan,
			Value: 500,
			Precision: 100,
		},
		CallBackURL: "https://api.example.com/balance-monitor",
	},
)
FieldTypeDescription
monitorIDstringMonitor ID to update.
BalanceIDstringBalance to monitor.
ConditionMonitorConditionThreshold rule with Field, Operator, Value, and Precision.
Condition.FieldstringBalance field to watch (for example credit_balance, debit_balance, balance).
Condition.OperatorMonitorConditionOperatorsComparison operator: >, <, =, !=, >=, <=.
Condition.Valueint64Threshold amount.
Condition.Precisionint64Currency precision (for example 100 for cents).
CallBackURLstringWebhook URL when the condition is met.
DescriptionstringOptional description for the monitor.
2

Confirm the update

On success, Core returns the updated monitor. Fetch the monitor with get balance monitor to verify the new condition and webhook URL.
3

Response

200 OK
{
  "monitor_id": "mon_e0e77b0c-4985-472a-9bf5-76a48b0259b0",
  "balance_id": "bln_5ce86029-3c2e-4e2a-aae2-7fb931ca4c4f",
  "condition": {
    "field": "credit_balance",
    "operator": "<",
    "value": 500,
    "precision": 100
  },
  "call_back_url": "https://api.example.com/balance-monitor",
  "created_at": "2024-02-20T05:56:58.257315054Z"
}
FieldTypeDescription
monitor_idstringUnique ID for the monitor.
balance_idstringBalance being monitored.
conditionobjectUpdated threshold rule.
call_back_urlstringWebhook URL for notifications.

Balance monitoring

Conditions and webhook behavior.

Update balance monitor

HTTP request and response schema.

​
Need help?

We are very happy to help you make the most of Blnk, regardless of whether it is your first time or you are switching from another tool. To ask questions or discuss issues, please contact us or join our Discord community.