DEdefaulr
Shares

Update a share

Changed on

Allows changing an existing share's published status, which removes authentication and makes it available to anyone with the link.

post/shares.update

Request

  • Base URL
    https://app.getoutline.com/api
  • URL
    https://app.getoutline.com/api/shares.update
  • 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
publishedboolean required
titlestring nullable

Override title displayed on the publicly shared page. If not set the source document or collection title is used.

iconUrlstring uri nullable

URL of an icon to display on the publicly shared page, overriding the workspace branding.

Response

OK

Example response

{
  "data": {
    "documentTitle": "React best practices",
    "includeChildDocuments": true,
    "allowSubscriptions": true,
    "createdBy": {
      "name": "Jane Doe"
    }
  },
  "policies": [
    {
      "abilities": {
        "read": true,
        "update": true,
        "delete": false
      }
    }
  ]
}

Changes

  • 9a99ee93e11dRevision changes
    • info

      added the optional property ////// to the response with the status

  • 33bab0a8aefcRevision changes
    • breaking

      the response property / became nullable for the status

    • breaking

      the / response's property type changed from object to no type for status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      the response optional property / became read-only for the status

    • info

      added to the / response property allOf list for the response status