Feature API Coverage

This is a map of the implemented API surfaces. It does not imply that every dashboard feature is exposed through an API key. Session/Bearer endpoints require the active workspace and appropriate role/plan; public read/submit endpoints still enforce publication, passwords, host scope and rate limits.

Feature Session/Bearer management Public surface External API key
Short links /v2/short-links/create, /update-basic, /update-domain, /update-restrictions, /update-seo, /update-utm, /update-retargeting, /update-routing, /update-qr-code, /update-deep-link, /toggle-status; GET /{id}, /list, /get-id Public short host /{code} with domain context Create, basic update, list, get; four analytics routes
QR links Short-link QR settings; QR has the same link identity Encoded public short URL; QR query tracking where supported Create/read underlying short link; QR style editing requires dashboard auth
LinkFolio / portfolio /v2/linkfolio/create, /update-basic, /update-links, content/social/theme/customization endpoints and /update-qr-code GET /v2/linkfolio/public/{username} and /public/{username}/effective-theme No dedicated LinkFolio key endpoints
Blog profiles/articles /api/v2/blog-folio/profile/create, profile update/list; article /create, /{id}/update; profile/page QR endpoints GET /api/v2/blog-folio/public-profile/{username}; /public/{username}/{slug} No dedicated blog key endpoints
Forms / surveys /v2/forms (alias /v2/surveys): create/list/get/update, publish workflow, responses/insights/export and /{id}/qr-code /v2/forms/public/{code}; POST /{code}/event, /submit, /attachments; respondent-profile read No dedicated forms key endpoints
Dynamic / deep links /v2/deeplink/links: POST/GET, /{id} GET/PUT/DELETE, /{id}/qr-code GET/PUT, /{id}/funnel; app configs separate /dl/{code} click; /v2/deeplink/query, /conversion POST for client SDK flows No dedicated deep-link key endpoints
Campaigns /v2/campaigns: GET/POST; /{id} GET/PATCH/DELETE; /{id}/assets POST, /{id}/assets/{assetId} DELETE, /{id}/analytics GET Linked assets retain their own public URLs/domains No dedicated campaign key endpoints
Custom domains /v2/domains: registration, verification, instructions, mapping, canonical config and removal /v2/domains/public/route and /resolve Key can create links on an already active authorized domain; no domain management key endpoints

Short-link editing

All update routes above are POST except where indicated. Use the opaque id in JSON and provide the request model's required fields. Basic updates require isActive; they are not JSON Merge Patch. Example:

{"id":"LINK_ID","title":"Launch","shortUrl":"launch","originalUrl":"https://example.com/new","isActive":true}

The external equivalent is PUT /v2/external/client/short-links/LINK_ID with that body. Changing an alias uses the same 1–24 ASCII/reserved-name/domain-collision policy as creation. Unchanged legacy aliases remain readable. Changing a destination and configuring routing run the same safety checks as creation. Domain reassignment is dashboard-authenticated POST /v2/short-links/update-domain with {"id":"LINK_ID","domainId":"DOMAIN_ID"}; detaching can generate a replacement code if the primary host already reserves the old code.

SEO, restrictions, UTM templates, retargeting pixels, advanced routing, deep-link settings and QR customization remain separate typed update endpoints; they are not accepted as arbitrary extra creation fields. Respect plan gating. QR-style saves must not toggle a resource's publication status.

Forms and public submissions

Forms/surveys share an implementation and route aliases. Use published codes, preserve X-YLNK-HOST where the public endpoint accepts it, and send the configured survey password header when required. File uploads use multipart file data, supported question metadata and server-enforced attachment limits; do not upload directly with platform storage secrets. Fetch the public form schema before building submissions; required fields, consent and access settings vary per form.

Deep links and QR behavior

Platform short-link routing accepts public HTTP(S) destinations. It is separate from the deep-link app configuration, associated domains, Android/iOS association files and deferred SDK query/conversion flows. Do not put an app URI scheme into a short-link destination and expect HTTP redirect handling to implement installation detection. QR rendering is client-side styling of a public resource URL; printing a QR does not publish an unpublished resource or bypass its password/access rules.

Campaigns

Campaigns group existing assets and aggregate their analytics. They do not create a new publicly routed campaign page or domain type. Retain each attached asset's type, stable ID and actual public domain. Apply the owning workspace's plan, asset-count and analytics permissions.

Full request models

The repository's feature controller and model files are the source for each feature's typed fields. Do not infer a universal payload across LinkFolio, blogs, forms, deep links and campaigns: they have separate publication, SEO, password and plan rules. The examples in the short-link and custom-domain guides cover the key-based integration contract; endpoints marked session/Bearer are intended for authenticated dashboard integrations, not public API-key clients.