v68

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-0170379386.9 KB
Collections

Update Collection

Update the properties of an existing Collection.

post/rest/api/v1/editcollection

Query parameters

localestring

The client's preferred locale in rfc5646 format (e.g. en, ja, pt-BR). If omitted, the Accept-Language will be used. If not present or not supported, defaults to the closest match or en.

Headers

X-Glean-ActAsstring email

Email address of a user on whose behalf the request is intended to be made (should be non-empty only for global tokens).

X-Glean-Auth-Typestring

Auth type being used to access the endpoint (should be non-empty only for global tokens).

Request body

namestring required

The unique name of the Collection.

descriptionstring

A brief summary of the Collection's contents.

iconstring

The emoji icon of this Collection.

adminLockedboolean

Indicates whether edits are allowed for everyone or only admins.

parentIdinteger

The parent of this Collection, or 0 if it's a top-level Collection.

allowedDatasourcestring

The datasource type this Collection can hold.

idinteger required

The ID of the Collection to modify.

Example request

{
  "addedRoles": [
    {
      "person": {
        "name": "George Clooney",
        "obfuscatedId": "abc123"
      }
    }
  ],
  "removedRoles": [
    {
      "person": {
        "name": "George Clooney",
        "obfuscatedId": "abc123"
      }
    }
  ],
  "audienceFilters": [
    {
      "fieldName": "type",
      "values": [
        {
          "value": "Spreadsheet",
          "relationType": "EQUALS"
        },
        {
          "value": "Presentation",
          "relationType": "EQUALS"
        }
      ]
    }
  ]
}

Response

OK

namestring required

The unique name of the Collection.

descriptionstring required

A brief summary of the Collection's contents.

iconstring

The emoji icon of this Collection.

adminLockedboolean

Indicates whether edits are allowed for everyone or only admins.

parentIdinteger

The parent of this Collection, or 0 if it's a top-level Collection.

allowedDatasourcestring

The datasource type this Collection can hold.

trackingTokenstring

An opaque token that represents this particular UGC. To be used for /feedback reporting.

idinteger required

The unique ID of the Collection.

createTimestring date-time
updateTimestring date-time
itemCountinteger

The number of items currently in the Collection. Separated from the actual items so we can grab the count without items.

childCountinteger

The number of children Collections. Separated from the actual children so we can grab the count without children.

shortcutsstring[]

The names of the shortcuts (Go Links) that point to this Collection.

errorCode'NAME_EXISTS' | 'NOT_FOUND' | 'COLLECTION_PINNED' | 'CONCURRENT_HIERARCHY_EDIT' | 'HEIGHT_VIOLATION' | 'WIDTH_VIOLATION' | 'NO_PERMISSIONS' | 'CORRUPT_ITEM' required