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: email_client
Available in API 2.0+
Send an email to an existing client.Required Parameters | Possible Values | Description |
client | Client ID | The numeric ID of the existing client to email |
subject | String | The subject line of the email |
body | Text | The main body of the email. HTML is allowed. This parameter becomes optional if the optional "invoice" parameter is used, otherwise it is required |
Optional Parameters | Possible Values | Description |
invoice | Invoice ID | The number/reference of an invoice to include within the email. Note: Only invoices for the specific client being emailed can be included. Attempting to include an invoice that's for a different client than is being emailed will not include the invoice with the email |
receipt | 0 | 1 | Available in API 2.45+ If a "receipt" parameter is included along with the "invoice" parameter, a receipt for specified invoice will be included |
style | String | Text | Available in API 2.45+ This optional parameter can be used to include custom CSS styling rules within the email |
Example Response |
{ "completed":"1" } |
Variables Returned | Description |
completed | Returns "1 " once the API call has completed |