Skip to main content
POST
Create a link for a document

Authorizations

Authorization
string
header
required

Workspace API key, prefixed rqk_.

Body

application/json
documentId
string
required

ID of the uploaded document.

workspace
string
required

Workspace slug, not its ID. Sending an ID returns 422 "workspace is required".

domain
string

Custom domain. Must already belong to the workspace, else 422. Defaults to rqk.sh.

key
string

Short key. Generated when omitted.

Response

Created

id
string
domain
string
Example:

"rqk.sh"

key
string

Short key. Combined with domain this forms the short URL.

url
string

Destination URL. Null for file links.

title
string
description
string
image
string
isActive
boolean
isArchived
boolean
isQR
boolean
isFile
boolean
expiresAt
string<date-time>
ios
string

iOS-specific destination.

android
string

Android-specific destination.

workspaceId
string
documentId
string
clicks
integer
createdAt
string<date-time>
updatedAt
string<date-time>