Update a collection

patch

Authorizations

useroauth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

collectionIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

Body

application/json

titlestring · max: 50Optional

Title of the collection

descriptionstring · max: 100Optional

Description of the collection

defaultLevelone ofOptional

Default level for a piece of content

string · enumOptional

"The role of a member in an organization. "admin": Can administrate the content: create, delete spaces, ... "create": Can create content. "review": Can review content. "edit": Can edit the content (live or change requests). "comment": Can access the content and its discussions. "read": Can access the content, but cannot update it in any way.

Possible values:

or

nullOptional

or

string · enumOptionalPossible values:

Responses

200

The collection has been updated

application/json

objectstring · enumRequired

Type of Object, always equals to "collection"

Possible values:

idstringRequired

Unique identifier for the collection

titlestring · max: 50Required

Title of the collection

descriptionstring · max: 100Optional

Description of the collection

organizationstringRequired

ID of the organization owning this collection

parentstringOptional

ID of the parent collection, if any

defaultLevelone ofRequired

Default level for a piece of content

string · enumOptional

"The role of a member in an organization. "admin": Can administrate the content: create, delete spaces, ... "create": Can create content. "review": Can review content. "edit": Can edit the content (live or change requests). "comment": Can access the content and its discussions. "read": Can access the content, but cannot update it in any way.

Possible values:

or

nullOptional

or

string · enumOptionalPossible values:

patch/collections/{collectionId}

HTTPcURLJavaScriptPython

PATCH /v1/collections/{collectionId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 60

{
  "title": "text",
  "description": "text",
  "defaultLevel": "admin"
}

200

The collection has been updated

{
  "object": "collection",
  "id": "text",
  "title": "text",
  "description": "text",
  "organization": "text",
  "parent": "text",
  "defaultLevel": "admin",
  "urls": {
    "location": "https://example.com",
    "app": "https://example.com"
  },
  "permissions": {
    "view": true,
    "admin": true,
    "viewInviteLinks": true,
    "create": true
  }
}