SMsmartsheet
groups

Update group

Updates the Group specified in the URL.

This operation is only available to group administrators and system administrators.

put/groups/{groupId}

Request

  • Base URL
    https://api.smartsheet.com/2.0
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://app.smartsheet.com/b/authorize
      Token URL: https://api.smartsheet.com/2.0/token scopes: ADMIN_USERS

Request body

namestring

name (Optional)

Must be unique within the organization account.

descriptionstring

Description (optional).

ownerIdnumber

ownerId (optional)

Id of an admin user to whom the group ownership is transferred.

Example request

{
  "name": "Renamed group",
  "description": "Some new description",
  "ownerId": 94094820842
}

Response

Result object containing the Group object for the updated group

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": 4583173393803140,
    "name": "Group 1",
    "description": "My group",
    "owner": "john.doe@smartsheet.com",
    "ownerId": 2331373580117892
  }
}

Changes

No recorded changes to this operation across all 16 revisions of this API.