Available 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 | 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 |
MIDAS API: del_client
MIDAS API: del_client