Skip to Content
Relink API is in beta.
DocumentationValidation Rules

Validation Rules

URL Validation

  • No Self-References: URLs cannot point to relink.is domains
  • Google Safe Browsing: All URLs are checked against Google’s Safe Browsing API for malware, social engineering, unwanted software, and potentially harmful applications
  • Supported Protocols: http, https, mailto, tel, sms, ftp, and others
  • Length: Exactly 6 characters (auto-generated URLs)
  • Characters: Only alphanumeric characters (a-z, A-Z, 0-9)
  • Reserved Words: Cannot use: dashboard, welcome, pp, tos
  • Uniqueness: Must be unique across the platform
  • Format Validation: Must match pattern ^[a-z0-9]{6}$ for auto-generated URLs

Content Limits

  • Smartlink Name: 64 characters max
  • Smartlink URL: 64 characters max (but only 6 chars for auto-generated)
  • Landing Title: 128 characters max
  • Landing Description: 256 characters max
  • DigiCard Title: 256 characters max
  • DigiCard Job Title: 128 characters max
  • DigiCard Company: 128 characters max
  • DigiCard CTA Text: 32 characters max
  • TxtBin Text: 2500 characters max
  • TxtBin Title: 256 characters max
  • TxtBin Description: 256 characters max

Color Validation

Theme colors must be valid hex colors:

  • #RGB (3 digits)
  • #RRGGBB (6 digits)
  • #RRGGBBAA (8 digits with alpha)

Password Validation

For URL shortener password protection:

  • Minimum Length: 6 characters
  • Required: When protected: true is set

Subscription-Based Restrictions

Starter Plan Limitations

  • App Store Links: Cannot use macOsAppLink and windowsAppLink fields
  • Smartlink Limit: Maximum 3 active smartlinks
  • Analytics: Limited to last 120 days of data

Professional/Enterprise Plans

  • App Store Links: All platforms supported
  • Smartlink Limits: Professional (10), Enterprise (unlimited)
  • Analytics: Full historical data access

Google Safe Browsing Integration

The API automatically validates all submitted URLs against Google’s Safe Browsing API to prevent malicious content:

Checked Threat Types:

  • MALWARE
  • SOCIAL_ENGINEERING
  • UNWANTED_SOFTWARE
  • POTENTIALLY_HARMFUL_APPLICATION

Validated URL Fields:

  • App store links (all platforms)
  • Fallback links
  • Shortener destination URLs
  • Landing page button links
  • QR tag button links
  • DigiCard button links

Error Response:

{ "error": "Unsafe URLs found: https://malicious-site.com", "status": 400 }