User API \ Delete a user

Send a DELETE request to the following resource to delete an existing user. The user's profile and the attached Social Identities will entirely be removed from your Site. Deleting a user from your Site will not delete the corresponding social profiles.

Resource/URI GET POST PUT DELETE
Users /users.<format> List all users – – –
User /users/<user_token>.<format> Retrieve a user's details – – Delete a user
User /users/<user_token>/contacts.<format> Read a user's contacts – – –
User /users/<user_token>/publish.<format> – Publish on social networks – –

Workflow

1. Request: the code to send to the API

Send a DELETE request to the resource /users/<user_token>.<format> to immediately delete an existing user. The <user_token> has to be replaced by the unique token of an existing user.

To prevent you from unintentionally deleting a user by mixing up the DELETE/GET methods you have to include the url parameter confirm_deletion=true in your DELETE requests. If you omit this parameter, the user will not be deleted and an error will be thrown.

2. Result: the code returned by the API

If the user has been deleted successfully, the API will return a HTTP Status Code 200. If the user could not be deleted, the API will return a HTTP Status Code other than 200 and an appropriate message body with further details on the error that occured.