Skip to main content
POST
Create link

Authorizations

Authorization
string
header
required

Your API key: Authorization: Bearer urldn_live_...

Headers

Idempotency-Key
string

Any unique value of up to 255 printable characters. Retrying with the same key and body within 24 hours returns the first response with Idempotent-Replayed: true and creates nothing. A failed attempt frees the key.

Maximum string length: 255

Body

application/json
url
string<uri>
required

Must be https. Internal and private addresses are rejected.

Maximum string length: 2048
customSlug
string
Pattern: ^[A-Za-z0-9_-]{4,14}$
domain
string

One of your verified custom domains, by name or id

title
string
Maximum string length: 120
tags
string[]
Maximum array length: 20
Maximum string length: 40

Response

The new link

id
string
required
shortUrl
string<uri>
required
shortCode
string
required
url
string<uri>
required

The destination

domain
string | null
required

Your custom domain, or null for the default

title
string | null
required
tags
string[]
required
isActive
boolean
required
isQrCode
boolean
required
hasPassword
boolean
required
expiresAt
string<date-time> | null
required
createdAt
string<date-time>
required