API ReferenceSmart Links
Enable or disable a smart link
Sets the active flag on a smart link. Requires a write-scoped key.
Authorization
bearerAuth AuthorizationBearer <token>
Your al_live_<prefix>_<secret> API key. Mint and manage keys in the dashboard.
In: header
Path Parameters
provider_id*string
The smart link's provider_id.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/admin/smart-links/string/toggle" \ -H "Content-Type: application/json" \ -d '{ "active": false }'{ "provider_id": "lnk_8fq2", "offer": "paid", "name": "IG bio - paid", "redirect_url": "https://app.tease.link/r/9fA2kQ7p", "active": false, "created_at": 1719705600}{ "detail": { "code": "unauthorized", "message": "Invalid or missing API key" }}{ "detail": { "code": "engine_not_connected", "message": "Connect your engine to access this data." }}{ "detail": { "code": "smart_link_not_found", "message": "Smart link 'lnk_unknown' not found" }}Retire a smart link
Soft-retires a smart link (sets it inactive) while preserving its stats and conversion history. Returns no content. Requires a write-scoped key.
List conversion pixels
Lists the Meta/TikTok CAPI pixel configurations attached to a smart link. The access token is never returned, only whether one is set. Requires a read-scoped key.