Branded URL Masking & White-Label Embedding

Preserve brand consistency and mask complex affiliate or third-party destination URLs in the browser address bar.

3 min read•Official Edge Documentation

Overview & Architecture

Branded URL Masking displays destination page content while keeping your branded domain in the visitor's browser address bar.

This technique is widely used for forms hosted on third-party SaaS platforms (Typeform, Notion, Airtable), and white-label enterprise client portals.

Key Principles

Core architectural pillars ensuring high performance, isolation, and security.

01Brand Preservation

Visitors constantly see your clean brand domain instead of a lengthy technical URL.

02Dynamic Titles & Favicons

Customize browser tab titles and favicons to perfectly match your brand identity.

03Secure Sandboxing

Safe containerization with strict Content-Security-Policy (CSP) headers protecting visitor privacy.

SDK Integration

Implementation & SDK Examples

Ready-to-use TypeScript code snippets and configuration examples for your integrations.

1. Creating a Masked Link

Set the maskUrl flag to true during link creation:

create-masked-link.ts

typescript

1234567891011
import { lshorter } from "@/lib/lshorter";
 
const maskedLink = await lshorter.links.create({
  url: "https://partner-affiliate-network.com/ref?aff_id=992834&campaign=summer",
  slug: "partner-deal",
  maskUrl: true,
  pageTitle: "Exclusive Partner Offer | LShorter",
});
 
console.log("Masked short link generated:", maskedLink.shortUrl);
// Output: https://lsho.cc/partner-deal

REST API Specification

API Endpoints & Reference

Direct HTTP request methods, parameters schema, authentication, and responses.

PATCH

Enable URL Masking

Bearer <API_KEY>60 to 1,400 req/min (by plan)

https://lsho.cc/api/v1/links/:id/masking

Enables or disables branded URL masking and configures the embedded page title and favicon metadata.

Path Parameters

Parameter	Type	Required	Description	Example
id	string	Required	Short link slug or ID.	`partner-deal`

Request Body Parameters

Parameter	Type	Required	Description	Example
maskUrl	boolean	Required	Set to true to enable branded masking.	`true`
pageTitle	string	Optional	Custom HTML title displayed in the browser tab.	`Exclusive Partner Offer \| LShorter`
faviconUrl	string (url)	Optional	Custom favicon image URL.	`https://my-brand.com/favicon.ico`

Request Examples

bash

12345678
curl -X PATCH "https://lsho.cc/api/v1/links/partner-deal/masking" \
  -H "Authorization: Bearer $LSHORTER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "maskUrl": true,
    "pageTitle": "Exclusive Partner Offer | LShorter",
    "faviconUrl": "https://my-brand.com/favicon.ico"
  }'

Response Payload

200 OKMasking parameters configured successfully.

response-200.json

json

123456789
{
  "id": "link_msk_1029481",
  "slug": "partner-deal",
  "shortUrl": "https://lsho.cc/partner-deal",
  "maskUrl": true,
  "pageTitle": "Exclusive Partner Offer | LShorter",
  "faviconUrl": "https://my-brand.com/favicon.ico",
  "status": "active"
}

Recommended Best Practices

Expert tips to maximize performance, resilience, and link security.

Recommendation 01

Ensure target destination websites allow iframe embedding (verify they do not send strict X-Frame-Options: DENY headers).

Recommendation 02

Set a clear pageTitle so the browser tab accurately reflects presented content.

Recommendation 03

Test responsive viewports on mobile devices to ensure embedded iframe content scrolls smoothly.

Previous guideClick Limits & Scheduled Expiration Next guideDynamic QR Code Generation API

Related Guides & APIs

1234567891011

import { lshorter } from "@/lib/lshorter"; const maskedLink = await lshorter.links.create({ url: "https://partner-affiliate-network.com/ref?aff_id=992834&campaign=summer", slug: "partner-deal", maskUrl: true, pageTitle: "Exclusive Partner Offer | LShorter", }); console.log("Masked short link generated:", maskedLink.shortUrl); // Output: https://lsho.cc/partner-deal

Parameter

Type

Required

Description

Example

string

Required

Short link slug or ID.

partner-deal

Parameter

Type

Required

Description

Example

maskUrl

boolean

Required

Set to true to enable branded masking.

true

pageTitle

string

Optional

Custom HTML title displayed in the browser tab.

Exclusive Partner Offer | LShorter

faviconUrl

string (url)

Optional

Custom favicon image URL.

https://my-brand.com/favicon.ico

12345678

curl -X PATCH "https://lsho.cc/api/v1/links/partner-deal/masking" \ -H "Authorization: Bearer $LSHORTER_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "maskUrl": true, "pageTitle": "Exclusive Partner Offer | LShorter", "faviconUrl": "https://my-brand.com/favicon.ico" }'

123456789

{ "id": "link_msk_1029481", "slug": "partner-deal", "shortUrl": "https://lsho.cc/partner-deal", "maskUrl": true, "pageTitle": "Exclusive Partner Offer | LShorter", "faviconUrl": "https://my-brand.com/favicon.ico", "status": "active" }