Delete

Delete

Deletes a single customer.

Request

Method
URL
POST
 https://api.solatech-dos.com/customers/v1/delete 

Headers

Name
Required
Type
Description
APIKey
Guid
A valid API key with a scope of Customers | Delete

Body

Property
Required
Type
Description
UniqueID
GUID
The unique ID of the customer.
ExternalID
Text
The external ID of the customer.
{
  "ExternalID": "",
  "UniqueID": "47222515-2eff-47bc-8cb7-1802653fadbd"
}

Remarks

To identify a customer, only the UniqueID OR the ExternalID are used. If both are supplied, the UniqueID will be used.
Customers that are being used cannot be deleted. A customer is considered being used if:
  • It's attached to a quote or sale.

Response

Headers

None

Status Code

Code
Description
200 OK
The customer was deleted.
400 Bad Request
The customer was not deleted. The reason why will be returned.
401 Unauthorized
The API key is missing, invalid, disabled, or does not have the correct scope.
404 Not Found
The customer was not found.

Body

The unique ID of the deleted customer and a message stating that the customer was deleted successfully.