API Guide v2.0

Update Group

HTTP Method & URL
PUT <base-url>&Type=Community&Version=1
<query parameters>
Parameters
Type <required> Communithy
Version <required> API version#
UserId <required> UserID of the user who is updating the group
CommunityId <required> ID of the group
CommunityType <optional> group_open 
  . group_open: Open Group
	  
   Group Type can only be changed from Restricted to Open.  If the group
   is already an open group, then there is no effect.
Description <optional> Group description
Name <optional> Group name
AddUsers <optional> List of the email addresses (separated by commas) of the users/members to be added to the group.
RemoveUsers <optional> List of the email addresses (separated by commas) of the users/members to be removed from the group.
Description
Update group information.
Notes
. In version 1.0, no email is sent to the users who are added to the group.
Returns
HTTP Status Code: 200 (success) or 400 (bad request)
Example Response
For a successful transaction, there is no XML response. For failed requests, the response is the standard XML error response as described in the API Summary section.

back to top

©2008 Connectbeam, Inc.