BObox
Groups

Update group

Changed on

Updates a specific group. Only admins of this group or users with admin-level permissions will be able to use this API.

put/groups/{group_id}

Request

  • Base URL
    https://api.box.com/2.0
  • URL
    https://api.box.com/2.0/groups/{group_id}
  • Auth
    OAuth 2
    Authorization code: https://account.box.com/api/oauth2/authorize
    Token URL: https://api.box.com/oauth2/token

Path parameters

group_idstring required

The ID of the group.

Query parameters

fieldsstring[]

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

namestring

The name of the new group to be created. Must be unique within the enterprise.

provenancestring

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.

external_sync_identifierstring

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.

descriptionstring

A human readable description of the group.

invitability_level'admins_only' | 'admins_and_members' | 'all_managed_users'

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.

member_viewability_level'admins_only' | 'admins_and_members' | 'all_managed_users'

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.

Example request

{
  "name": "Customer Support",
  "provenance": "Active Directory",
  "external_sync_identifier": "AD:123456",
  "description": "\"Customer Support Group - as imported from Active Directory\"",
  "invitability_level": "admins_only",
  "member_viewability_level": "admins_only"
}

Response

Returns the updated group object.

idstring required

The unique identifier for this object.

type'group' required

The value will always be group.

namestring

The name of the group.

group_type'managed_group' | 'all_users_group'

The type of the group.

created_atstring date-time

When the group object was created.

modified_atstring date-time

When the group object was last modified.

provenancestring

Keeps track of which external source this group is coming from (e.g. "Active Directory", "Google Groups", "Facebook Groups"). Setting this will also prevent Box users from editing the group name and its members directly via the Box web application. This is desirable for one-way syncing of groups.

external_sync_identifierstring

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.

descriptionstring

Human readable description of the group.

invitability_level'admins_only' | 'admins_and_members' | 'all_managed_users'

Specifies who can invite the group to collaborate on items.

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.

member_viewability_level'admins_only' | 'admins_and_members' | 'all_managed_users'

Specifies who can view the members of the group (Get Memberships for 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.

Example response

{
  "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",
  "permissions": {
    "can_invite_as_collaborator": true
  }
}

Changes

  • c4d5303fa5c3Revision changes
    • warning

      added the new unprocessable_entity enum value to the response property for the response status

    • warning

      added the new unprocessable_entity enum value to the response property for the response status