DEdefaulr
Pins

Pin a document

Changed on

Pin a document to the top of a collection or to the home screen. Pinned documents are visible to all members of the workspace. Provide a collectionId to pin within a collection, or omit it to pin to the home screen.

post/pins.create

Request

  • Base URL
    https://app.getoutline.com/api
  • URL
    https://app.getoutline.com/api/pins.create
  • 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

documentIdstring uuid required

Identifier for the document to pin.

collectionIdstring uuid nullable

Identifier for the collection to pin the document to. Omit to pin to the home screen.

indexstring

An optional fractional index to control the position of the pin.

Response

OK

Example response

{
  "policies": [
    {
      "abilities": {
        "read": true,
        "update": true,
        "delete": false
      }
    }
  ]
}

Changes