Skip to Content
DocumentationAPI Overview

Smartlink API Documentation

Overview

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

Key Features

  • GraphQL-like Reactive Body: Single endpoint handles all smartlink types with reactive validation
  • Type-Based Validation: Required fields automatically validated based on smartlink type
  • Google Safe Browsing: All URLs are automatically checked for safety
  • Comprehensive Coverage: Supports all smartlink types (App, URL, Landing, QRTag, DigiCard, TxtBin)
  • Partial Updates: PATCH operations support selective field updates
  • Standardized Responses: Consistent response format across all endpoints

Base URL

All API requests should be made to:

https://relink.is/api/v1

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:

{
  "success": false,
  "error": {
    "code": "SUBSCRIPTION_LIMIT_REACHED",
    "message": "API access is not available for Starter subscription. Please upgrade your plan to use API features."
  },
  "timestamp": "2024-01-15T10:30:00.000Z"
}

Required Setup

  1. Active Professional or Enterprise subscription
  2. Valid API key (created through the dashboard)
  3. Bearer token authentication with your API key

The API supports six different smartlink types:

  • App: Mobile app store links with fallback URLs
  • Url: Simple URL shortener with optional password protection
  • Landing: Custom landing page with multiple action buttons
  • QRTag: QR code page with action buttons and presets
  • DigiCard: Digital business card with contact information
  • TxtBin: Text sharing with formatting and syntax highlighting

Response Format

All API responses follow a standardized format:

Success Response

{
  "success": true,
  "message": "Operation completed successfully",
  "data": { /* response data */ },
  "timestamp": "2024-01-15T10:30:00.000Z"
}

Error Response

{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "Human readable error message",
    "details": [
      {
        "path": "field.path",
        "message": "Field specific error"
      }
    ]
  },
  "timestamp": "2024-01-15T10:30:00.000Z"
}
Quick StartAuthentication