Tuyu Developers

Developers

Customize the URLs on this site with your Tuyu URL:

https:// .
Method Documentation > Users and Workspaces

Remove User from User Group POST

Description

Remove a user from a 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 “remove_from_user_group”)

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

Restrictions

The calling user must have:

  • Admin privileges for the site.

Parameters

Bold indicates required.

Parameter Description
api_key Your API Key.
user_id The ID of the user being removed from the user group.
user_group_ids A comma-separated list of user group IDs the user can be removed from.
timestamp The current time in Unix timestamp format.
signature Please see “User Authentication” for more information.

Sample Response

Successful response In JSON:

{"removeFromUserGroup":{"userId":10045, "userGroupIds": 4561,4567}}

Successful response in XML:

<removeFromUserGroup>
    <userId>10045</userId>
    <userGroupIds>4561,4567</userGroupIds>
</removeFromUserGroup>

Error response In JSON:

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

Error response In XML:

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

Methods in Users and Workspaces