API Methods: groups.editGroup

Description

Edits or creates groups on a site.

Authentication

This method requires authentication with 'write' permission.

API Version

Version 1&2

Required parameters

  • None

Optional parameters

  • group_id :
    the id number of the group. If this is included, the group is edited instead of creating a new one. The list of group ids is available from the groups.getList call.
  • name :
    the name of the group. If a group_id is not included, this parameter is required to create a new group.
  • description :
    a brief description of the group
  • group_owner_id :
    the id number of the user who owns the group. The list of user ids is available from the users.getList call.
  • access :
    the access level of the group. This has four possible values:
    • 0 : Public - all users can view and create content in the group
    • 1 : Open - all users can view group content, members can create content
    • 2 : Closed - only members can view and create group content
    • 3 : Hidden - only members can see that the group exists
  • news :
    this is a place for the group administrators and moderators to post updates about the group
  • welcome_message :
    this is a message shown on the groups main page to welcome guests and members
  • state :
    the state associated with this group
  • country :
    the contry associated with this group
  • permalink :
    the permalink used to access the group. This can be appended to the site url (ex. http://SITENAME/PERMALINK).
  • ss_key : the key of the community associated with the group. The list of communities is available from the communities.getList call.
  • interest_key : the key of a site interest associated with the group. The list of interests is available from the siteinterests.getList call.
  • subinterest_key : the key of a site sub-interest associated with the group. The list of interests is available from the siteinterests.getList call.

Example response

<?xml version="1.0"?>
<response status="ok" time="Tue, 22 Apr 2008 09:33:08 -0500">
    <groups count="1">
        <group>
            <group_id>6</group_id>
        </group>
    </groups>
</response>