MIDAS API: notify_user

Available in API 2.0+

Sends an internal notification to a MIDAS user.

The notification will appear in the user's "Notification Center", and may also be forwarded to their email address if they have configured message forwarding.

Required Parameters	Possible Values	Description
user	User ID \| User email	The numeric ID of the existing user to message, or their email address (Note: If an email address is supplied which doesn't match an existing user, the message will fail)
msg	Text	The message to send
expires	Valid date and time (Format: YYYYMMDDHHMM)	The date/time after which the message should expire and be automatically removed from the recipient's My Messages screen (The user may choose to manually remove the message sooner)

Optional Parameters	Possible Values	Description
type	message \| reminder	Sets the type of notification to send. If omitted, the type will be set to "`message`"

Example Response

{
	"completed":"1"
}

Variables Returned	Description
completed	Returns "`1`" once the API call has completed

Table of contents