Skip to main content
PUT
/
group_memberships
/
{group_membership_id}
cURL
curl -i -X PUT "https://api.box.com/2.0/group_memberships/434534" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -H "content-type: application/json" \
     -d '{
       "role": "admin"
     }'
{
  "id": "11446498",
  "type": "group_membership",
  "user": {
    "id": "11446498",
    "type": "user",
    "name": "Aaron Levie",
    "login": "[email protected]"
  },
  "group": {
    "id": "11446498",
    "type": "group",
    "name": "Support",
    "group_type": "managed_group"
  },
  "role": "member",
  "created_at": "2012-12-12T10:53:43-08:00",
  "modified_at": "2012-12-12T10:53:43-08:00"
}
This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.Learn more about Box SDK versioning strategy.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
group_membership_id
string
required

The ID of the group membership.

Query Parameters

​
fields
string[]

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.

Body

application/json
​
role
enum<string>

The role of the user in the group.

Available options:
member,
admin
Example:

"member"

​
configurable_permissions
object

Custom configuration for the permissions an admin if a group will receive. This option has no effect on members with a role of member.

Setting these permissions overwrites the default access levels of an admin.

Specifying a value of null for this object will disable all configurable permissions. Specifying permissions will set them accordingly, omitted permissions will be enabled by default.

Example:
{ "can_run_reports": true }

Response

Returns a new group membership object.

Membership is used to signify that a user is part of a group.

​
id
string

The unique identifier for this group membership.

Example:

"11446498"

​
type
enum<string>

The value will always be group_membership.

Available options:
group_membership
Example:

"group_membership"

​
user
User (Mini) · object

The user that the membership applies to.

​
group
Group (Mini) · object

The group that the membership applies to.

​
role
enum<string>

The role of the user in the group.

Available options:
member,
admin
Example:

"member"

​
created_at
string<date-time>

The time this membership was created.

Example:

"2012-12-12T10:53:43-08:00"

​
modified_at
string<date-time>

The time this membership was last modified.

Example:

"2012-12-12T10:53:43-08:00"