POST /api/v3/account/{accountId}/alert

Creates a new alert (notification or note) on an account

CreateAccountAlertV3 Permissions: Accounts (Edit)

Use this endpoint to attach a new alert message to an account. Alerts are visible during bill entry and account management, serving as notes, warnings, or action items displayed to users when they view the account or enter bills against it. The alert is associated with the account’s form record. To view existing alerts, use GET /account/{accountId}/alert. To modify an existing alert, use PUT /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 to attach the alert to	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 application/json

{  "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 application/json

{  "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.