SP.GroupCollection.removeById Method (sp.js)

  • Article

Removes the group with the specified member ID from the collection.

Applies to: apps for SharePoint | SharePoint Foundation 2013 | SharePoint Server 2013

SP.GroupCollection.removeById()

Parameters

  • id
    A 32-bit integer that specifies the member ID of the group to be removed.

Return value

Undefined

Exceptions

SPException

The group collection is read-only.

Remarks

Use the SP.GroupCollection.remove method to remove a group at a specified index in the group collection.

REST resource endpoint

See GroupCollection resource for more information.

Endpoint URI structure

http://<sitecollection>/<site>/_api/web/sitegroups/removeById(id)

HTTP requests

This resource supports the following HTTP commands:

  • POST

POST syntax

POST http://<sitecollection>/<site>/_api/web/sitegroups/removeById(id)

Resource parameters

  • id