DEdefaulr
Collections

Duplicate a collection

Changed on

Duplicate an existing collection along with its published documents. The original collection's settings – icon, color, permission, sharing, and sorting – are preserved on the copy. Draft and archived documents are not duplicated. Document duplication runs asynchronously in the background, so the copy may initially be returned before all of its documents have been created.

post/collections.duplicate

Request

  • Base URL
    https://app.getoutline.com/api
  • URL
    https://app.getoutline.com/api/collections.duplicate
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://app.getoutline.com/oauth/authorize
      Token URL: https://app.getoutline.com/oauth/token scopes: read, write

Request body

idstring uuid required

Unique identifier for the collection to duplicate.

namestring

An optional name for the new collection. If omitted, the original collection's name is reused.

Response

OK

Example response

{
  "data": {
    "urlId": "hDYep1TPAM",
    "name": "Human Resources",
    "index": "P",
    "color": "#123123",
    "archivedBy": {
      "name": "Jane Doe"
    }
  },
  "policies": [
    {
      "abilities": {
        "read": true,
        "update": true,
        "delete": false
      }
    }
  ]
}

Changes