POST residentapi/alertmessages

Create an alert message

Request Information

URI Parameters

None.

Body Parameters

Alert message to create

Name	Description	Type	Additional information
UnitId	ConnectUnitId. Id of the unit that the message belongs to. See GET /residentapi/units/{unitID}	integer	Required
Message	Message.	string	Required
Url	Url. The url to navigate to when the message is clicked.	string	None.

Request Formats

application/json, text/json

Sample:

{
  "unitId": 1,
  "message": "sample string 2",
  "url": "sample string 3"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AlertMessage

Name	Description	Type	Additional information
MessageId	MessageId. Unique Identifier for a message..	integer	None.
UnitId	ConnectUnitId. Id of the unit that the message belongs to. See GET /residentapi/units/{unitID}	integer	None.
Message	Message.	string	None.
Url	Url. The url to navigate to when the message is clicked.	string	None.
ReadOn	Date the message was read (null if not read)	date	None.
CreatedOn	CreatedOn. Date the notification was created.	date	None.

Response Formats

application/json, text/json

Sample:

{
  "messageId": 1,
  "unitId": 2,
  "message": "sample string 3",
  "url": "sample string 4",
  "readOn": "2025-12-24T09:12:05.4133928-05:00",
  "createdOn": "2025-12-24T09:12:05.4133928-05:00"
}