Skip to main content
POST
Create a new link for a document within a workspace

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
documentId
string

ID of the document

workspace
string

Workspace URL

domain
string

The domain under which the link will be created

Example:

"example.com"

key
string

The key to be used for the link

Example:

"unique-key-123"

Response

Link created successfully

id
string

The ID of the created link

Example:

"link123"

documentId
string

The document ID linked to the workspace

Example:

"doc123"

projectId
string

The ID of the workspace associated with the link

domain
string

The domain for the link

Example:

"example.com"

key
string

The key for the link

Example:

"unique-key-123"

usage
object
_count
object
views
object[]