POST
/
links
/
new
/
{workspace}

Authorizations

Authorization
string
headerrequired

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

Path Parameters

workspace
string
required

The URL of the workspace where the short link will be created

Query Parameters

subscriptionId
string
required

The subscription ID associated with the workspace

Body

multipart/form-data
file
file

The social card image file to upload

domain
string
default: rqk.sh

The domain under which the link will be created

key
string

The key to be used for the link

url
string
default:

The URL the link points to

isPublic
boolean | null

Visibility of the link

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

Description of the social card link

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

Title of the social card link

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

URL of the image associated with the link

expiresAt
string | null

Expiration date and time of the link

password
string | null

Password required to access the link

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
link_id
string

The ID of the created link

link_url
string

The short URL of the created Link

Create a new document linkUpdate a link