Table of Contents
- API Usage Guide
- API Command Reference
- add_booking
- add_client
- add_invoice
- add_resource
- approve_request
- authenticate_user
- del_booking
- del_bookings
- del_client
- del_invoice
- del_resource
- email_client
- gen_invoice
- get_activity
- get_availability
- get_booking
- get_booking_type
- get_booking_types
- get_bookings
- get_client
- get_consumable_levels
- get_invoice
- get_invoices
- get_messages
- get_reminders
- get_resource
- get_resource_availability
- get_setting
- get_template
- get_user
- get_users_logged_in
- get_venue
- get_venue_groups
- get_venues
- get_venues_in_group
- get_venues_in_use
- get_watches
- mod_booking
- mod_client
- mod_invoice
- mod_resource
- mod_venue
- notify_user
- reject_request
- restore_booking
- set_setting
- set_template
- util_api_usage
- util_from_epoch
- util_to_epoch
- Appendix A - Activity Codes
- Appendix B - Setting Names
- Appendix C - Error Handling
- Code Samples
- Troubleshooting
- Release Notes
← Hide Table of Contents
MIDAS API: notify_user
MIDAS API: notify_userAvailable 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 |