Table of Contents
- API Usage Guide
- API Command Reference
- add_booking
- add_client
- add_invoice
- add_resource
- add_venue_group
- approve_request
- authenticate_user
- del_booking
- del_bookings
- del_client
- del_invoice
- del_resource
- del_venue_group
- 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
- mod_venue_group
- 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: del_client
MIDAS API: del_clientAvailable in API 2.0+
Deletes existing client records.| Required Parameters (at least 1 required) | Possible Values | Description |
| id | Client ID | The unique numerical id of the client (which can be determined from the "get_client" call) Passing this parameter will override all other required parameters |
| client | String | Client name |
| org | String | Organization name |
| Email Address | Email address | |
| address | String | Postal/Mailing address |
| phone | Number | Telephone number |
| fax | Number | Fax number |
| mobile | Number | Mobile/Cell number |
| notes | String | Notes about the client |
| Optional Parameters | Possible Values | Description |
| retain_bookings | 1 | 0 | By default, when a client is deleted, all associated bookings for the client are also deleted. Passing the retain_bookings parameter with a value of "1" will mean that no bookings will be removed when a client is deleted |
| Example Response |
{
"clients_deleted":"1",
"bookings_deleted":"24"
} |
| Variables Returned | Description |
| clients_deleted | The number of clients deleted |
| bookings_deleted | The number of bookings deleted |