Tuyu Developers

Developers

Customize the URLs on this site with your Tuyu URL:

https:// .
Method Documentation > Users and Workspaces

User Group Delete POST DELETE

Description

Delete an existing user group.

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_group_delete”)

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

Restrictions

The calling user must have:

  • Admin privileges for the site.

Parameters

Bold indicates required.

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

Sample Response

Successful response In JSON:

{"userGroupDeleted":{"userGroupId":10045}}

Successful response in XML:

<userGroupDeleted>
    <userGroupId>10045</userId>
</userGroupDeleted>

Error response In JSON:

{"error":{
    "title":"'User Group Delete Failed",
    "message":"Please try again or contact customer support."}
}

Error response In XML:

<error>
    <title>'User Group Delete Failed</title>
    <message>Please try again or contact customer support.</message>
</error>