Updates an existing alert's message text or type on an account
Use this endpoint to modify an existing alert on an account — for example, to correct a typo in the message
or change the alert type. The alert must already exist on the specified account.
To create a new alert, use POST /account/{accountId}/alert.
To delete an alert, use DELETE /account/{accountId}/alert/{alertId}.
Request Headers
| Header | Value | Required | Description |
|---|---|---|---|
| ECI-ApiKey | string | Yes | Your API key. See Authentication. |
| Content-Type | application/json | Yes | All requests must specify JSON content type, including the request body. |
Path Parameters
| Name | Description | Type | Required |
|---|---|---|---|
| accountId | The unique numeric identifier of the account the alert belongs to | integer (int32) | Required |
| alertId | The unique numeric identifier of the alert to update | integer (int32) | Required |
Request Body
AccountAlertRequest
| Property | Description | Type |
|---|---|---|
| allowBillProcessing | When true, bills can still be processed despite this alert. When false, the alert blocks bill processing. Required | boolean |
| beginDate | The date the alert becomes active and visible. Format: date-only (e.g., 2024-01-01). Must be between 1899-12-31 and 3000-01-01. Required Must be between 1899-12-31 and 3000-01-01 | string (date-time) |
| endDate | The date the alert expires and is no longer displayed. Must be greater than or equal to BeginDate. Format: date-only (e.g., 2024-12-31). Required Must be between 1899-12-31 and 3000-01-01 Must be greater than or equal to BeginDate | string (date-time) |
| message | The alert message text to display to users during bill entry and account management Required | string |
Example Request Body
{ "allowBillProcessing": false, "beginDate": "2026-06-29", "endDate": "2026-06-29", "message": "string"
}Responses
200
OK
The request succeeded and the response body contains the requested data.
Response Body Parameters
AccountAlertResponse
| Property | Description | Type |
|---|---|---|
| alertId | The unique identifier for this alert | integer (int32) |
| allowBillProcessing | When true, bills can still be processed despite this alert. When false, the alert blocks bill processing. | boolean |
| beginDate | The date the alert becomes active and visible | string (date-time) |
| endDate | The date the alert expires and is no longer displayed | string (date-time) |
| message | The alert message text displayed to users | string |
Example Response
{ "alertId": 1, "allowBillProcessing": false, "beginDate": "2026-06-29", "endDate": "2026-06-29", "message": "string"
}
404
Not Found
The requested resource was not found. Verify the ID or path is correct.