TEASEDocs
API ReferenceSmart Links

Create or update a conversion pixel

Creates or updates the Meta/TikTok CAPI pixel config for a smart link. The access token is write-only; omitting or blanking it on an update keeps the existing token, and a token is required when creating a new pixel. 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

application/json

PUT
/api/admin/smart-links/{provider_id}/pixels
curl -X PUT "https://example.com/api/admin/smart-links/string/pixels" \  -H "Content-Type: application/json" \  -d '{    "platform": "meta",    "pixel_id": "1234567890",    "access_token": "EAAB...redacted",    "event_map_json": "{\\"subscription\\":\\"Subscribe\\",\\"ppv\\":\\"Purchase\\"}",    "active": true  }'
{  "platform": "meta",  "pixel_id": "1234567890",  "active": true,  "event_map_json": "{\"subscription\":\"Subscribe\",\"ppv\":\"Purchase\"}",  "has_token": true,  "updated_at": 1719792000}

{  "detail": {    "code": "invalid_platform",    "message": "platform must be one of ['meta', 'tiktok']"  }}

{  "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"  }}

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.

Delete a conversion pixel

Removes the pixel config for the given smart link and platform. Returns no content. Requires a write-scoped key.