Upsert shortcut

curl --request PUT \
  --url https://api.uselora.com/v1/shortcuts/{handle} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "destination": "<string>",
  "title": "<string>",
  "description": "<string>",
  "masked": false,
  "password": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "ios": "<string>",
  "android": "<string>",
  "geo": {},
  "folderId": "<string>"
}
'

import requests

url = "https://api.uselora.com/v1/shortcuts/{handle}"

payload = {
    "destination": "<string>",
    "title": "<string>",
    "description": "<string>",
    "masked": False,
    "password": "<string>",
    "expiresAt": "2023-11-07T05:31:56Z",
    "ios": "<string>",
    "android": "<string>",
    "geo": {},
    "folderId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    destination: '<string>',
    title: '<string>',
    description: '<string>',
    masked: false,
    password: '<string>',
    expiresAt: '2023-11-07T05:31:56Z',
    ios: '<string>',
    android: '<string>',
    geo: {},
    folderId: '<string>'
  })
};

fetch('https://api.uselora.com/v1/shortcuts/{handle}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.uselora.com/v1/shortcuts/{handle}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'destination' => '<string>',
    'title' => '<string>',
    'description' => '<string>',
    'masked' => false,
    'password' => '<string>',
    'expiresAt' => '2023-11-07T05:31:56Z',
    'ios' => '<string>',
    'android' => '<string>',
    'geo' => [
        
    ],
    'folderId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.uselora.com/v1/shortcuts/{handle}"

	payload := strings.NewReader("{\n  \"destination\": \"<string>\",\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"masked\": false,\n  \"password\": \"<string>\",\n  \"expiresAt\": \"2023-11-07T05:31:56Z\",\n  \"ios\": \"<string>\",\n  \"android\": \"<string>\",\n  \"geo\": {},\n  \"folderId\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.uselora.com/v1/shortcuts/{handle}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"destination\": \"<string>\",\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"masked\": false,\n  \"password\": \"<string>\",\n  \"expiresAt\": \"2023-11-07T05:31:56Z\",\n  \"ios\": \"<string>\",\n  \"android\": \"<string>\",\n  \"geo\": {},\n  \"folderId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.uselora.com/v1/shortcuts/{handle}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"destination\": \"<string>\",\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"masked\": false,\n  \"password\": \"<string>\",\n  \"expiresAt\": \"2023-11-07T05:31:56Z\",\n  \"ios\": \"<string>\",\n  \"android\": \"<string>\",\n  \"geo\": {},\n  \"folderId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "slug": "<string>",
  "url": "<string>",
  "destination": "<string>",
  "title": "<string>",
  "description": "<string>",
  "icon": "<string>",
  "image": "<string>",
  "video": "<string>",
  "archived": true,
  "masked": true,
  "passwordProtected": true,
  "expiresAt": "<string>",
  "ios": "<string>",
  "android": "<string>",
  "geo": {},
  "placeholders": [
    {
      "name": "<string>",
      "default": "<string>"
    }
  ],
  "folderId": "<string>",
  "tagIds": [],
  "externalId": "<string>",
  "tenantId": "<string>",
  "comments": "<string>",
  "workspaceId": "<string>",
  "userId": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "slug": "<string>",
  "url": "<string>",
  "destination": "<string>",
  "title": "<string>",
  "description": "<string>",
  "icon": "<string>",
  "image": "<string>",
  "video": "<string>",
  "archived": true,
  "masked": true,
  "passwordProtected": true,
  "expiresAt": "<string>",
  "ios": "<string>",
  "android": "<string>",
  "geo": {},
  "placeholders": [
    {
      "name": "<string>",
      "default": "<string>"
    }
  ],
  "folderId": "<string>",
  "tagIds": [],
  "externalId": "<string>",
  "tenantId": "<string>",
  "comments": "<string>",
  "workspaceId": "<string>",
  "userId": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

{
  "error": "<string>",
  "requestId": "<string>",
  "code": "<string>",
  "fieldErrors": {},
  "traceId": "<string>"
}

{
  "error": "<string>",
  "requestId": "<string>",
  "code": "<string>",
  "traceId": "<string>"
}

{
  "error": "<string>",
  "requestId": "<string>",
  "code": "<string>",
  "traceId": "<string>",
  "required_scope": "<string>"
}

{
  "error": "<string>",
  "requestId": "<string>",
  "code": "<string>",
  "traceId": "<string>"
}

{
  "error": "<string>",
  "requestId": "<string>",
  "code": "<string>",
  "traceId": "<string>"
}

{
  "error": "<string>",
  "requestId": "<string>",
  "code": "<string>",
  "traceId": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "requestId": "<string>",
  "traceId": "<string>"
}

Shortcuts

Upsert shortcut

Creates a shortcut at the given slug, or updates the existing one. Returns 201 when a new shortcut is created and 200 when an existing one is updated. The handle is taken verbatim as the slug — for symmetry with GET/PATCH/DELETE the segment is named {handle}, but PUT does not resolve UUID-shaped handles to a row’s ID. One guardrail: a UUID-shaped handle that collides with an existing shortcut’s id returns 400 validation_error (use PATCH /v1/shortcuts/{handle} to update by ID); UUID-shaped slugs that don’t collide are accepted as slugs.

PUT

shortcuts

{handle}

Upsert shortcut

curl --request PUT \
  --url https://api.uselora.com/v1/shortcuts/{handle} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "destination": "<string>",
  "title": "<string>",
  "description": "<string>",
  "masked": false,
  "password": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "ios": "<string>",
  "android": "<string>",
  "geo": {},
  "folderId": "<string>"
}
'

import requests

url = "https://api.uselora.com/v1/shortcuts/{handle}"

payload = {
    "destination": "<string>",
    "title": "<string>",
    "description": "<string>",
    "masked": False,
    "password": "<string>",
    "expiresAt": "2023-11-07T05:31:56Z",
    "ios": "<string>",
    "android": "<string>",
    "geo": {},
    "folderId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    destination: '<string>',
    title: '<string>',
    description: '<string>',
    masked: false,
    password: '<string>',
    expiresAt: '2023-11-07T05:31:56Z',
    ios: '<string>',
    android: '<string>',
    geo: {},
    folderId: '<string>'
  })
};

fetch('https://api.uselora.com/v1/shortcuts/{handle}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.uselora.com/v1/shortcuts/{handle}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'destination' => '<string>',
    'title' => '<string>',
    'description' => '<string>',
    'masked' => false,
    'password' => '<string>',
    'expiresAt' => '2023-11-07T05:31:56Z',
    'ios' => '<string>',
    'android' => '<string>',
    'geo' => [
        
    ],
    'folderId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.uselora.com/v1/shortcuts/{handle}"

	payload := strings.NewReader("{\n  \"destination\": \"<string>\",\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"masked\": false,\n  \"password\": \"<string>\",\n  \"expiresAt\": \"2023-11-07T05:31:56Z\",\n  \"ios\": \"<string>\",\n  \"android\": \"<string>\",\n  \"geo\": {},\n  \"folderId\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.uselora.com/v1/shortcuts/{handle}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"destination\": \"<string>\",\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"masked\": false,\n  \"password\": \"<string>\",\n  \"expiresAt\": \"2023-11-07T05:31:56Z\",\n  \"ios\": \"<string>\",\n  \"android\": \"<string>\",\n  \"geo\": {},\n  \"folderId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.uselora.com/v1/shortcuts/{handle}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"destination\": \"<string>\",\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"masked\": false,\n  \"password\": \"<string>\",\n  \"expiresAt\": \"2023-11-07T05:31:56Z\",\n  \"ios\": \"<string>\",\n  \"android\": \"<string>\",\n  \"geo\": {},\n  \"folderId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "slug": "<string>",
  "url": "<string>",
  "destination": "<string>",
  "title": "<string>",
  "description": "<string>",
  "icon": "<string>",
  "image": "<string>",
  "video": "<string>",
  "archived": true,
  "masked": true,
  "passwordProtected": true,
  "expiresAt": "<string>",
  "ios": "<string>",
  "android": "<string>",
  "geo": {},
  "placeholders": [
    {
      "name": "<string>",
      "default": "<string>"
    }
  ],
  "folderId": "<string>",
  "tagIds": [],
  "externalId": "<string>",
  "tenantId": "<string>",
  "comments": "<string>",
  "workspaceId": "<string>",
  "userId": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "slug": "<string>",
  "url": "<string>",
  "destination": "<string>",
  "title": "<string>",
  "description": "<string>",
  "icon": "<string>",
  "image": "<string>",
  "video": "<string>",
  "archived": true,
  "masked": true,
  "passwordProtected": true,
  "expiresAt": "<string>",
  "ios": "<string>",
  "android": "<string>",
  "geo": {},
  "placeholders": [
    {
      "name": "<string>",
      "default": "<string>"
    }
  ],
  "folderId": "<string>",
  "tagIds": [],
  "externalId": "<string>",
  "tenantId": "<string>",
  "comments": "<string>",
  "workspaceId": "<string>",
  "userId": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

{
  "error": "<string>",
  "requestId": "<string>",
  "code": "<string>",
  "fieldErrors": {},
  "traceId": "<string>"
}

{
  "error": "<string>",
  "requestId": "<string>",
  "code": "<string>",
  "traceId": "<string>"
}

{
  "error": "<string>",
  "requestId": "<string>",
  "code": "<string>",
  "traceId": "<string>",
  "required_scope": "<string>"
}

{
  "error": "<string>",
  "requestId": "<string>",
  "code": "<string>",
  "traceId": "<string>"
}

{
  "error": "<string>",
  "requestId": "<string>",
  "code": "<string>",
  "traceId": "<string>"
}

{
  "error": "<string>",
  "requestId": "<string>",
  "code": "<string>",
  "traceId": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "requestId": "<string>",
  "traceId": "<string>"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

handle

string

required

The shortcut's slug.

Body

application/json

The desired state of the shortcut at this slug. tagIds and similar associations aren't accepted here — use POST /v1/shortcuts or PATCH /v1/shortcuts/{handle} for those.

destination

string

required

The destination URL of the short link.

Maximum string length: 32000

Examples:

"https://google.com"

"mailto:hello@example.com"

"tel:+1234567890"

"notion://workspace/page"

title

string | null

Optional title for the shortcut

description

string | null

Optional description for the shortcut

visibility

enum<string>

Visibility level. Omit to keep the current value when updating an existing shortcut, or to default to WORKSPACE when creating a new one.

Available options:

PRIVATE,

WORKSPACE,

UNLISTED

masked

boolean

default:false

Whether to mask the destination URL

password

The password required to access the destination URL of the shortcut.

Required string length: 1 - 256

expiresAt

string<date-time> | null

The date and time when the short link will expire at.

ios

The iOS destination URL for the shortcut for iOS device targeting.

Maximum string length: 32000

android

The Android destination URL for the shortcut for Android device targeting.

Maximum string length: 32000

geo

Geo · object | null

Geo targeting information for the short link in JSON format {[COUNTRY]: https://example.com }

Show child attributes

folderId

string

The 8-character ID of an existing folder to assign the shortcut to. Defaults to the workspace's default folder when omitted.

Pattern: ^[0-9abcdefghjkmnpqrstvwxyz]{8}$

Example:

"a1b2c3d4"

Response

The existing shortcut at this slug was updated.

A shortcut.

string<uuid>

required

The shortcut's unique ID.

slug

string

required

The shortcut slug.

url

string

required

Workspace-scoped short link. Open this URL to record a click and redirect to the destination.

Example:

"https://app.uselora.com/acme/short/handbook"

destination

string

required

The destination URL of the short link.

title

string | null

required

description

string | null

required

icon

string | null

required

image

string | null

required

video

string | null

required

visibility

enum<string>

required

Available options:

PRIVATE,

WORKSPACE,

UNLISTED,

PUBLIC

archived

boolean

required

Whether the short link is archived. Defaults to false if not provided.

masked

boolean

required

passwordProtected

boolean

required

Whether this shortcut requires a password before redirecting. The password hash is never returned.

expiresAt

string | null

required

The date and time when the short link will expire at.

ios

string | null

required

The iOS destination URL for the shortcut for iOS device targeting.

android

string | null

required

The Android destination URL for the shortcut for Android device targeting.

geo

Geo · object | null

required

Geo targeting information for the short link in JSON format {[COUNTRY]: https://example.com }

Show child attributes

placeholders

PlaceholderDescriptor · object[]

required

Dynamic placeholders parsed from the destination URL. Empty for static destinations. See docs/dynamic-placeholders.md.

Show child attributes

folderId

string

required

The 8-character ID of the folder this shortcut belongs to.

Pattern: ^[0-9abcdefghjkmnpqrstvwxyz]{8}$

Example:

"a1b2c3d4"

tagIds

string[]

required

The unique IDs of the tags assigned to the shortcut.

Pattern: ^[0-9abcdefghjkmnpqrstvwxyz]{8}$

Example:

["a1b2c3d4"]

externalId

string | null

required

The ID of the link in your database. If set, it can be used to identify the link in future API requests (the ext_ prefix is recommended on query parameters for visual disambiguation but the server accepts both prefixed and bare values). This key is unique across your workspace.

tenantId

string | null

required

The ID of the tenant that created the link inside your system. If set, it can be used to fetch all links for a tenant.

comments

string | null

required

The comments for the short link.

workspaceId

string

required

ID of the workspace the shortcut belongs to.

userId

string

required

ID of the user who created the shortcut.

createdAt

string

required

ISO 8601 creation timestamp.

updatedAt

string

required

ISO 8601 timestamp of the last update.

Retrieve shortcut Delete shortcut

Lora API

Shortcuts

Tags

Folders

QR Codes

Upsert shortcut

Authorizations

Path Parameters

Body

Response