Sign in

v1

latestOpenAPI 3.0.32026-08-061874701.5 MB
groupMembers

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.

post/groups/{groupId}/members

Request body

OR

Example request

{
  "id": 2331373580117892,
  "email": "john.doe@smartsheet.com",
  "firstName": "John",
  "lastName": "Doe",
  "name": "John Doe"
}

Response

Returns a Result object containing the members added to the group -- either a single GroupMember or array of GroupMember objects, corresponding to what was specified in the request.

This operation is asynchronous, meaning the users may not yet have sharing access to sheets for a period of time after this operation returns. For small groups with limited sharing, the operation should complete quickly (within a few seconds). For large groups with many shares, this operation could possibly take more than a minute to complete.

message'PARTIAL_SUCCESS' | 'SUCCESS'

Message that indicates the outcome of the request. (One of SUCCESS or PARTIAL_SUCCESS.)

resultCode0 | 3
  • '0' Success
  • '3' Partial Success of Bulk Operation

Example response

{
  "message": "SUCCESS",
  "result": {
    "id": 2331373580117892,
    "email": "john.doe@smartsheet.com",
    "firstName": "John",
    "lastName": "Doe",
    "name": "John Doe"
  }
}