Create a share

Creates a new share link that can be used by to access a document. If you request multiple shares for the same document with the same API key, the same share object will be returned. By default all shares are unpublished.

post/shares.create

Request body

documentIdstring uuid required

Response

Example response

{
  "data": {
    "documentTitle": "React best practices",
    "includeChildDocuments": true,
    "createdBy": {
      "name": "Jane Doe"
    }
  }
}

Changes

Changed in 2 of the 6 revisions of this API.10

Oct 18, 2024fdf2ec9c9df41See the full diff
- ○
  added the non-success response with the status 429
  response-non-success-status-added
Jul 6, 20247b33b538cd7d9See the full diff
- ○
  added the optional property data to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property data to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property data to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property message to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property message to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property message to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property status to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property status to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property status to the response with the 403 status
  response-optional-property-added

Full history