Manage Applications

    Update group

    put
    https://api.box.com/2.0
    /groups/:group_id

    Updates a specific group.

    Request

    application/json

    Path Parameters

    stringin pathrequired
    57645

    The ID of the group.

    Query Parameters

    string arrayin queryoptional
    id,type,name

    A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.

    Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.

    Request Body

    stringin bodyoptional
    "Customer Support Group - as imported from Active Directory"255

    A human readable description of the group.

    stringin bodyoptional
    AD:123456

    An arbitrary identifier that can be used by external group sync tools to link this Box Group to an external group.

    Example values of this field could be an Active Directory Object ID or a Google Group ID.

    We recommend you use of this field in order to avoid issues when group names are updated in either Box or external systems.

    stringin bodyoptional
    admins_only

    Specifies who can invite the group to collaborate on folders.

    When set to admins_only the enterprise admin, co-admins, and the group's admin can invite the group.

    When set to admins_and_members all the admins listed above and group members can invite the group.

    When set to all_managed_users all managed users in the enterprise can invite the group.

    Value is one of "admins_only", "admins_and_members", "all_managed_users"

    stringin bodyoptional
    admins_only

    Specifies who can see the members of the group.

    • `admins_only - the enterprise admin, co-admins, group's group admin
    • admins_and_members - all admins and group members
    • all_managed_users - all managed users in the enterprise

    Value is one of "admins_only", "admins_and_members", "all_managed_users"

    stringin bodyoptional
    Customer Support

    The name of the new group to be created

    stringin bodyoptional
    Active Directory255

    Keeps track of which external source this group is coming, for example "Active Directory", or "Okta".

    Setting this will also prevent Box admins from editing the group name and its members directly via the Box web application.

    This is desirable for one-way syncing of groups.

    Response

    application/jsonGroup

    Returns the updated group object.

    You can now try out some of our APIs live, right here in the documentation.
    Log In

    Request Example

    cURL
    curl -X PUT https://api.box.com/2.0/groups/57645 \
         -H "Authorization: Bearer <ACCESS_TOKEN>" \
         -H "Content-Type: application/json" \
         -d '{
           "name": "Customer Support"
         }'
    .NET
    var updates = new BoxGroupRequest()
    {
        Name = "New group name"
    };
    BoxGroup updatedGroup = await client.GroupsManager.UpdateAsync("11111", updates);
    Java
    BoxGroup group = new BoxGroup(api, id);
    BoxGroup.Info groupInfo = group.getInfo();
    groupInfo.addPendingChange("name", "New name for My Group");
    group.updateInfo(groupInfo);
    Python
    group_update = {'name': 'New Group Name'}
    updated_group = client.group(group_id='11111').update_info(group_update)
    print('Changed the name of group {0} to "{1}"'.format(updated_group.id, updated_group.name))
    Node
    client.groups.update('11111', {name: 'New group name'})
    	.then(group => {
    		/* group -> {
    			type: 'group',
    			id: '11111',
    			name: 'New group name',
    			created_at: '2014-09-15T13:15:35-07:00',
    			modified_at: '2014-09-16T13:15:35-07:00' }
    		*/	
    	});

    Response Example

    {
      "id": 11446498,
      "type": "group",
      "name": "Support",
      "group_type": "managed_group",
      "created_at": "2012-12-12T10:53:43-08:00",
      "modified_at": "2012-12-12T10:53:43-08:00",
      "provenance": "Active Directory",
      "external_sync_identifier": "AD:123456",
      "description": "Support Group - as imported from Active Directory",
      "invitability_level": "admins_only",
      "member_viewability_level": "admins_only"
    }