Skip To Content

/createGroup: Create Group

  • URL:https://[root]/community/createGroup(POST only)

Example usage

URL for Create Group


https://www.arcgis.com/sharing/rest/community/createGroup
title=Street Maps
access=account
description=The street map group provides street maps for the city of Redlands.
sortField=avgrating
sortOrder=desc

Description

The Create Group operation (POST only) creates a new group in the Portal community.

Only authenticated users can create groups. The user who creates the group automatically becomes the owner of the group. The owner of the group is automatically an administrator of the group. The calling user provides the title for the group, while the group ID is generated by the system.

Request Parameters

ParameterDetails
[Common Parameters]

For a complete listing, see Common parameters.

[Create Group Parameters]

For a complete listing of the available Create Group parameters, see Group parameters in Common parameters.

Response Properties

PropertyDetails
success

Indicates if the operation was successful.

group

The JSON group object representing the created group. See the Group response properties for the properties returned.

JSON Response Syntax


            {    "success": true | false    
"group": { {
  "id": "<group id>",
  "title": "<group title>"
  "isInvitationOnly": true | false,
  "owner": "<group owner username>",
  "description": "<description>",
  "snippet": "<summary>",
  "tags": [
      "<tag1>",
      "<tag2>",
      "<tag3>"
  ]
  "phone": "<contact>",
  "sortField": "<title | owner | avgrating | numviews | created | modified>",
  "sortOrder": "< asc | desc>",
  "isViewOnly": "<false | true>",
  "thumbnail": file name,
  "created": date created shown in UNIX time,
  "access": "private | org |  public"
  }
}

JSON Response Example


            {    "success": true,    
"group": {  
  "id": "981213ddd719410ab5ef973afd56263a",
  "title": "Street Maps",
  "isInvitationOnly": false,
  "owner": "jsmith",
  "description": "The street maps group provides street maps for the city of Redlands.",
  "snippet": "City of Redlands maps",
  "tags": [
      "Redlands",
      "street",
      "maps"
  ]
  "phone": "https://www.esri.com",
  "sortField": "avgrating",
  "sortOrder": "desc",
  "isViewOnly": false,
  "thumbnail": streets.jpg,
  "created": 1251142226000,
  "access": "public"
  }
}