Tuyu Developers

Developers

Customize the URLs on this site with your Tuyu URL:

https:// .
Method Documentation > Users and Workspaces

User Group Add POST

Description

Create 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 “user_group_add”)

https://{{ siteInfo.subdomain }}.{{ siteInfo.domain }}/api/user_group_add

Restrictions

The calling user must have:

  • Admin privileges for the site.

Parameters

Bold indicates required.

Parameter Description
api_key Your API Key.
name The name of the user group being created.
group_users A comma-separated list of user IDs to add to the newly created user group.
timestamp The current time in Unix timestamp format.
signature Please see “User Authentication” for more information.

Sample Response

Successful response In JSON:

{"userGroupAdd":{"userGroupId":10045, "userGroupMembers": 4561,4567}}

Successful response in XML:

<userGroupAdd>
    <userGroupId>10045</userId>
    <userGroupMembers>4561,4567</userGroupMembers>
</userGroupAdd>

Error response In JSON:

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

Error response In XML:

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

Methods in Users and Workspaces