Add Group Members
Adds one or more members to a group.
This operation supports both single-object and bulk semantics. For more information, see Optional Bulk Operations.
If called with a single GroupMember object, and that group member already exists, error code 1129 is returned. If called with an array of GroupMember objects, any users specified in the array that are already group members are ignored and omitted from the response.
This operation is only available to group administrators and system administrators.
path Parameters
| groupId required | number Group Id |
header Parameters
| Authorization | string API Access Token used to authenticate requests to Smartsheet APIs. Example: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789 |
Request Body schema: application/json
| id | number Group member's user Id. |
string <email> Group member's email address. | |
| firstName | string Group member's first name. |
| lastName | string Group member's last name. |
| name | string Group member's full name. |
Responses
Request samples
- Payload
- cURL
- C#
- Java
- Node.js
- Python
- Ruby
[ ]Response samples
- 200
- default
{- "message": "SUCCESS",
- "resultCode": 0,
- "result": {
- "id": 2331373580117892,
- "email": "john.doe@smartsheet.com",
- "firstName": "John",
- "lastName": "Doe",
- "name": "John Doe"
}
}Delete Group Members
Removes a member from a group.
This operation is only available to group administrators and system administrators.
path Parameters
| groupId required | number Group Id |
| userId required | number User Id |
header Parameters
| Authorization | string API Access Token used to authenticate requests to Smartsheet APIs. Example: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789 |
Responses
Request samples
- cURL
- C#
- Java
- Node.js
- Python
- Ruby
curl https://api.smartsheet.com/2.0/groups/{groupId}/members/{userId} \ -H "Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789" \ -X DELETE
Response samples
- 200
- default
{- "message": "SUCCESS",
- "resultCode": 0
}