Tuyu Developers

Developers

Customize the URLs on this site with your Tuyu URL:

https:// .
Method Documentation > Users and Workspaces

User Delete POST DELETE

Description

Deletes a user.

URL

All responses are in JSON format by default, to specify an XML response add “.xml” to the end of the method name (in this case “user_delete”)

https://<your subdomain>.<your domain>/api/user_delete

Restrictions

The calling user must have:

  • Admin privileges for the site.

Parameters

Bold indicates required.

Parameter Description
user_id The ID of the user to be deleted.
api_key Your API Key.
timestamp The current time in Unix timestamp format.
signature Please see “User Authentication” for more information.

Sample Response

Successful response In JSON:

{"userDelete":{"userId":1}}

Successful response in XML:

<userDelete>
    <userId>1</userId>
</userDelete>

Error response In JSON:

{"error":{
    "title":"'User Delete Failed",
    "message":"You must be an administrator to call this method"}
}

Error response In XML:

<error>
    <title>'User Delete Failed</title>
    <message>You must be an administrator to call this method</message>
</error>