Sign in

v68

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

Create Collection

Create a publicly visible (empty) Collection of documents.

post/rest/api/v1/createcollection

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.

newNextItemIdstring

The (optional) ItemId of the next CollectionItem in sequence. If omitted, will be added to the end of the Collection. Only used if parentId is specified.

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

OR