POST
/
links
/
document
curl --request POST \
  --url https://api.reqlick.com/links/document \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "documentId": "<string>",
  "workspace": "<string>",
  "domain": "example.com",
  "key": "unique-key-123"
}'
{
  "id": "link123",
  "documentId": "doc123",
  "projectId": "<string>",
  "domain": "example.com",
  "key": "unique-key-123",
  "usage": {
    "userId": "user123",
    "projectId": "<string>",
    "subscriptionId": "sub123",
    "snap_asset_type": "link",
    "snap_link_url": "example.com/unique-key-123"
  },
  "_count": {
    "views": 0
  },
  "views": [
    {}
  ]
}

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

200
application/json
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[]