v1

latestOpenAPI 3.0.32026-08-061874701.5 MB

groups

Add group

Creates a new group.

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

post/groups

Request body

namestring

name (required)

Must be unique within the organization account.

descriptionstring

description (optional)

Example request

{
  "name": "API-created group",
  "description": "Group created via API",
  "members": [
    {
      "email": "john.doe@smartsheet.com"
    }
  ]
}

Response

Result object, containing a Group object for the newly created 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
  }
}