DEdefaulr
Stars

Create a star

Changed on

Stars a document or collection so it appears in the users sidebar. One of either documentId or collectionId must be provided.

post/stars.create

Request

  • Base URL
    https://app.getoutline.com/api
  • URL
    https://app.getoutline.com/api/stars.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
collectionIdstring uuid
indexstring

Response

OK

Example response

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

Changes

  • 304cd065561bRevision changes
    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • warning

      removed the optional property / from the response with the status

    • info

      added the optional property / to the response with the status

  • 2b998aa571f9Revision changes
    • info

      endpoint added