Skip to main content
POST
links.short.update

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
endUserRef
string
required

Your own reference for the end user, 1 to 128 letters, digits, '_', '.' or '-'. Never an email or name.

Pattern: ^[A-Za-z0-9_.-]{1,128}$
ref
string
required

The ref returned by links.short.create.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
destinationUrl
string
required

The new long URL. Plain http or https only; no credentials in the URL.

Response

The result

shortUrl
string
required

The short URL. Share this.

destinationUrl
string
required

Where the short link sends people.

slug
string

The slug (the part after the domain).

createdAt
string

When the link was created, ISO 8601.

clicks
number

Total clicks on the link.