JSON API » customers » customers/delete

Marks a customer as deleted. They then cannot use the system. To purge them, use customers/purge. To undelete them, use customers/undelete.

Input parameters

Requires authentication and the commerce role privilege.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
id	Integer	ID of customer to delete.	Yes

Responses

Code	Description
204	Success.
400	The customer has sub-customers, or is an affiliate for other customers.
401	The authentication details provided are invalid.
402	Your role does not allow this.
404	The customer does not exist, or you do not have permission to delete it.

Data returned

No data is returned.

Example: With required parameters

http://enswitch.example.com/api/json/customers/delete/?auth_username=user;auth_password=password;id=123

{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }

Change history

Version	Changes
3.13	Function added.