/updateInfo: Update Collaboration Info

URL:
https://[root]/portals/[portalID]/collaborations/[collaborationID]/updateInfo
Methods:
POST
Required Capability:
Administrator (host)
Version Introduced:
10.5

Example usage

The following is a sample ArcGIS Online POST request for the updateInfo operation:

Use dark colors for code blocksCopy
1
2
3
4
5
6
POST /sharing/rest/portals/0123456789ABCDEF/collaborations/eefa7ebb30aa435382cc9b27ffa95e3e/updateInfo HTTP/1.1
Host: org.arcgis.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

name=Test Collaboration&description=Test description for distributed collaboration&config={"ownerUsername":"admin"}&f=pjson

The following is a sample ArcGIS Enterprise POST request for the updateInfo operation:

Use dark colors for code blocksCopy
1
2
3
4
5
6
POST /webadaptor/sharing/rest/portals/0123456789ABCDEF/collaborations/eefa7ebb30aa435382cc9b27ffa95e3e/updateInfo HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

name=Test Collaboration&description=Test description for distributed collaboration&config={"ownerUsername":"admin"}&f=pjson

Description

The updateInfo operation updates certain properties of a collaboration, primarily its name, description, and configuration properties. The updates are propagated to guests when the next scheduled refresh of content occurs.

Request parameters

ParameterDetails

name

The name of the collaboration. The collaboration name has a limit of 100 characters.

Example

Use dark colors for code blocksCopy
1
name=Test Collaboration

description

The description of the collaboration. The collaboration description has a limit of 250 characters.

Example

Use dark colors for code blocksCopy
1
description=Test Description for distributed collaboration

config

The configuration properties of the collaboration.

Example

Use dark colors for code blocksCopy
1
{"ownerUsername":"admin"}

f

The response format. The default format is html.

Values: html | json | pjson

JSON Response example

Use dark colors for code blocksCopy
1
2
3
{
  "success": true
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.