GEgetlago
wallets

Update a wallet alert

Changed on

This endpoint allows you to update an existing alert for a wallet. A non-empty thresholds array replaces the whole set of thresholds on the alert. When thresholds is left out, or sent as an empty array, the thresholds already on the alert are kept. A threshold sent with a code it already had, and without notify_on, keeps the notify_on it had.

put/customers/{external_customer_id}/wallets/{wallet_code}/alerts/{code}

Request

Request body

Example request

{
  "alert": {
    "code": "wallet_balance_alert",
    "name": "Wallet Balance Alert",
    "thresholds": [
      {
        "code": "warn",
        "notify_on": [
          "triggered",
          "resolved"
        ]
      }
    ]
  }
}

Response

Wallet alert updated

Example response

{
  "alert": {
    "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
    "lago_organization_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
    "lago_wallet_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
    "wallet_code": "wallet_code",
    "alert_type": "wallet_balance_amount",
    "code": "wallet_balance_alert",
    "name": "Wallet Balance Alert",
    "direction": "decreasing",
    "previous_value": "1000.0",
    "last_processed_at": "2025-05-19T10:04:21Z",
    "thresholds": [
      {
        "code": "warn",
        "notify_on": [
          "triggered",
          "resolved"
        ],
        "value": "99.0"
      }
    ],
    "created_at": "2025-03-20T10:00:00Z"
  }
}

Changes

  • 5d26657495a3Revision changes
    • breaking

      request property //////// list-of-types was narrowed by removing types integer from media type application/json

    • breaking

      the / response's property type changed from number to string for status

    • info

      added the new optional request property ///////////

    • info

      the ///////// request property type was generalized from integer to number

    • info

      added the optional property /////// to the response with the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the //// response's property pattern was changed from ^[0-9]+.?[0-9]*$ to ^-?[0-9]+(\.[0-9]+)?$ for the status