API Guide v2.0

Create Group

HTTP Method & URL
POST <base-url>?Type=Community&Version=1
<query parameters>
Parameters
Type <required> Community
Version <required> API version#
UserId <required> UserID of the user who is creating the group
Name <required> Name of the group
CommunityType <optional> Should be one of the following values: 
  . private - User's Private (Personal) group
  . group_restricted - Restricted group
  . group_open - Open group (default)
Description <optional> Group description
Description
Creates a new group.
Returns
HTTP Status Code: 201 (successfully created) or 400 (bad request)
HTTP Header: CommunityId (representing the ID# for the community)
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.