Introduction

The Links API is the foundation of Hoko, enabling you to create, manage, and track short links programmatically.

Overview

(GET) Retrieve links with flexible filtering by ID, external ID, tenant, or partner
(POST) Create one or more links with rich metadata and UTM parameters
(PUT) Update existing links or create new ones with upsert operations
(DELETE) Soft delete links while preserving historical analytics data

Links are the core building blocks of Hoko. Every short link you create becomes a trackable touchpoint that connects your marketing efforts to business outcomes.

The Links API provides full CRUD operations (Create, Read, Update, Delete) for managing your link library. Create branded short URLs, organize them with collections, attach UTM parameters for campaign tracking, and leverage partner attribution for affiliate programs.

Each link automatically generates a unique short ID and branded short URL, making it easy to share and track across all your marketing channels. Links support rich metadata including titles, descriptions, images, and custom external IDs for seamless integration with your existing systems.

Getting Started

Before creating links, ensure you have at least one collection in your workspace. Every link must belong to a collection for organization. Use externalId to maintain references to links in your own system for seamless synchronization.