online-help.platform.features.premier_subscription.connectors.inbound-rest-api.endpoints.customer.title
Delete Customer
Overview
Deletes Customer of the client
URL Format
https://{domain}.mobiwork.com/api/rest/{clientId}/{versionNumber}/customer/{customerId}/delete.html?token=XXXXXXXX&userId={userId}
Arguments
clientId
required
MobiWork assigned unique ID of the company
versionNumber
required
Version number of MobiWork API SDK release. Current version is: 10.0.78
token
required
Part of URL as a request parameter and is required in every call to verify access to API calls
customerId
required
The identifier of the customer to be deleted
userId
optional
If provided, this User ID will be taken as a logged in user. If not provided we use an active global administrator ID
Return
Returns a delete success message if valid arguments are provided. Returns an error if not a valid request. An error could occur when a customer is associated to work order(s).
Request Body XSD
None
Response Body XSD
Curl Example
HTTP Method: GET
Request: curl -k -X GET "https://www.mobiwork.com/api/rest/12014/10.0.78/customer/501266/delete.html?token=COJL8X2FKSLMMRTYCH2B"
Response: <?xml version="1.0" encoding="UTF-8" ?>
<response version="10.0.78" statusCode="1">Customer delete is successful</response>
OR
<?xml version="1.0" encoding="UTF-8" ?> <response version="10.0.78" statusCode="2">
<error code="1010">Customer is associated with work order(s), so delete not allowed
</response>