JSON API » people » people/delete

Deletes a person, and optionally any features they own.

Input parameters

Requires authentication and the administrator or wholesale role privileges.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
id	Integer	ID of person to delete.	Yes
features	Integer	1 to also delete any features this person owns, 0 not to.	No	0

Responses

Code	Description
204	Success.
400	Invalid input parameters specified. Check the key and message fields for more details.
401	The authentication details provided are invalid.
402	Your role does not allow this.
404	The person does not exist, or you do not have permission to delete them.

Data returned

No data is returned.

Example: With required parameters

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

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

Change history

Version	Changes
3.13	Function added.