Update a low balance alert for a customer account

🚧 Coming soon

Use PATCH {URI} customers/{customerIdentifier}/accounts/{accountIdentifier}/lowbalance/{balanceAlertID}

to update an existing low balance alert for a specific account under a customer. Low balance alerts notify stakeholders when an account’s balance falls below a defined threshold. Updating an alert may involve changing the threshold amount, notification method, or recipient list to reflect new financial strategies or operational needs. This endpoint ensures that alert configurations remain accurate and aligned with current business or customer requirements.

Use case

Acme Wellness uses low balance alerts to monitor funding levels in customer accounts that support automated wellness rewards. A customer decides to raise the alert threshold on their rewards account to ensure earlier notifications and avoid payout delays. Acme updates the alert using Tango API to reflect the new threshold and add an additional email recipient.

Use the following endpoint to update a low balance alert:

Endpoint	Purpose
`PATCH {URI} customers/{customerIdentifier}/accounts/{accountIdentifier}/lowbalance/{balanceAlertID}`	Update a low balance alert for a specific Account under a Customer

The following parameters are part of your URL path for this API request. customerIdentifier is a string used to identify the Group (Customer) that contains the account you are transacting from. customerIdentifier is essential when working with endpoints that involve customer-specific data, especially when multiple customers may have accounts with similar structures or identifiers:

Path param	Data type	Requirement	Description
customerIdentifier	string	required	A unique string that identifies a specific customer within the system. It's used to associate deleting low balance alerts with the correct customer record.
accountIdentifier	string	required	A unique string that identifies a specific account belonging to a customer. It's used in combination with the `customerIdentifier` to accurately target the correct account when deleting low balance alerts. `accountIdentifier` ensures that you interact with the right account when there are multiple accounts.
balanceAlertID	uuid	required	A universally unique identifier (UUID) that represents a specific low balance alert configured for a customer's account. It is used to precisely identify which alert should be deleted when calling the DELETE endpoint. `balanceAlertID` ensures that only the intended alert is removed, especially in cases where multiple alerts may exist for the same account with different thresholds or notification settings.

The following data can be sent in the body of your request to the server:

Body params	Data type	Requirement	Description
balanceAlertDisplayName	string	required	A friendly name for this low balance alert (will be displayed in the Tango Portal).
balanceAlertThreshold	string	required	The threshold amount that will trigger the low balance alert.
balanceAlertNotification	array of objects	optional	Send low balance notification emails to the following address(es). A provided list replaces the existing list, an empty list clears all existing emails, and a null/omitted value leaves the list unchanged.

Here is an example of the returned payload:

{
  "createdAt": "2025-07-15T17:00:04.933Z",
  "balanceAlertID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "customerIdentifier": "string",
  "accountIdentifier": "string",
  "balanceAlertDisplayName": "string",
  "balanceAlertThreshold": 0,
  "balanceAlertNotification": [
    {
      "emailAddress": "string"
    }
  ]
}

The possible response codes for this endpoint are as follows. For details, see i18nkey codes and their error messages:

Response code	Meaning
200	The request was successful.
400	The server could not understand the request due to invalid syntax.
401	Authentication is required and has either not been provided or failed.
403	The server understood the request but refuses to authorize it.
409	The server understands the request but cannot process it due to semantic errors.
500	Something went wrong on the server, but the server cannot be more specific about what the exact problem is.