POST
/
documents
/
{url}

Authorizations

Authorization
string
headerrequired

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

Path Parameters

url
string
required

The URL of the workspace where the document will be uploaded

Query Parameters

subscriptionId
string
required

The subscription ID

Body

multipart/form-data
file
file

The document file to upload

card
file

The social card image file to upload

domain
string
default: rqk.sh

The domain associated with the document

key
string

The key for the document

name
string | null
default:

Document name

isPublic
boolean | null

Visibility of the document

description
string
default: Turn your files into shareable links and connect effortlessly

Document description

title
string | null
default: Instant File Sharing Link with Reqlick

Title of the document

image
string | null
default: /_static/thumbnail.png

URL of the image associated with the document

expiresAt
string | null

Expiration date and time of the document link

password
string | null

Password required to access the document

ios
string | null

iOS-specific information

android
string | null

Android-specific information

utm_source
string | null

UTM source parameter for tracking

utm_medium
string | null

UTM medium parameter for tracking

utm_campaign
string | null

UTM campaign parameter for tracking

utm_term
string | null

UTM term parameter for tracking

utm_content
string | null

UTM content parameter for tracking

ref
string | null

Referral information

Response

200 - application/json
document_id
string

Document ID

Short link ID for the document

Short link URL for the document