Smartlink API Documentation

Overview

The Smartlink API provides a comprehensive RESTful interface for programmatically managing your smartlinks. This API allows you to create, update, and configure different types of smartlinks including app store redirections, URL shorteners, landing pages, QR code pages, digital business cards, and text sharing pages.

Prerequisites

Subscription Requirements

API access is only available for users with paid subscription plans:

✅ Professional Plan: Full API access
✅ Enterprise Plan: Full API access
❌ Starter Plan: API access restricted
❌ Free/None Plan: No API access

Important: Users with Starter subscriptions will receive a 403 error when attempting to use API keys:


{
  "error": "API access is not available for Starter subscription. Please upgrade your plan to use API features."
}

Required Setup

Active Professional or Enterprise subscription
Valid API key (created through the dashboard)
Existing smartlink to update (API currently supports UPDATE operations only)