ebd602e4aea4

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-1091438458.0 KB

Collections

Update Collection item

Update the URL, Glean Document ID, description of an item within a Collection given its ID.

post/rest/api/v1/editcollectionitem

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.

Request body

namestring

The optional name of the Collection item.

descriptionstring

A helpful description of why this CollectionItem is in the Collection that it's in.

iconstring

The emoji icon for this CollectionItem. Only used for Text type items.

collectionIdinteger required

The ID of the Collection to edit CollectionItems in.

itemIdstring required

The ID of the CollectionItem to edit.

Response

Example response

{
  "collection": {
    "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"
          }
        ]
      }
    ],
    "creator": {
      "name": "George Clooney",
      "obfuscatedId": "abc123"
    },
    "updatedBy": {
      "name": "George Clooney",
      "obfuscatedId": "abc123"
    },
    "items": [
      {
        "createdBy": {
          "name": "George Clooney",
          "obfuscatedId": "abc123"
        },
        "document": {
          "metadata": {
            "container": "container",
            "parentId": "JIRA_EN-1337",
            "createTime": "2000-01-23T04:56:07.000Z",
            "datasource": "datasource",
            "author": {
              "name": "name"
            },
            "documentId": "documentId",
            "updateTime": "2000-01-23T04:56:07.000Z",
            "mimeType": "mimeType",
            "objectType": "Feature Request",
            "components": [
              "Backend",
              "Networking"
            ],
            "status": "Done",
            "customData": {
              "someCustomField": {
                "stringValue": "someCustomValue"
              }
            }
          }
        },
        "shortcut": {
          "addedRoles": [
            {
              "person": {
                "name": "George Clooney",
                "obfuscatedId": "abc123"
              }
            }
          ],
          "removedRoles": [
            {
              "person": {
                "name": "George Clooney",
                "obfuscatedId": "abc123"
              }
            }
          ],
          "createdBy": {
            "name": "George Clooney",
            "obfuscatedId": "abc123"
          },
          "updatedBy": {
            "name": "George Clooney",
            "obfuscatedId": "abc123"
          },
          "destinationDocument": {
            "metadata": {
              "container": "container",
              "parentId": "JIRA_EN-1337",
              "createTime": "2000-01-23T04:56:07.000Z",
              "datasource": "datasource",
              "author": {
                "name": "name"
              },
              "documentId": "documentId",
              "updateTime": "2000-01-23T04:56:07.000Z",
              "mimeType": "mimeType",
              "objectType": "Feature Request",
              "components": [
                "Backend",
                "Networking"
              ],
              "status": "Done",
              "customData": {
                "someCustomField": {
                  "stringValue": "someCustomValue"
                }
              }
            }
          },
          "roles": [
            {
              "person": {
                "name": "George Clooney",
                "obfuscatedId": "abc123"
              }
            }
          ]
        }
      }
    ],
    "roles": [
      {
        "person": {
          "name": "George Clooney",
          "obfuscatedId": "abc123"
        }
      }
    ]
  }
}