TEASEDocs
API ReferenceLandings

Rename a landing domain

Update a domain's editable metadata (currently the `display_name` shown in stats). Takes effect immediately without a publish. 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

hostname*string

The domain hostname.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

PATCH
/api/admin/domains/{hostname}
curl -X PATCH "https://example.com/api/admin/domains/string" \  -H "Content-Type: application/json" \  -d '{    "display_name": "TikTok Q3"  }'
{  "hostname": "links.creator.com",  "display_name": "TikTok Q3",  "created_at": 1719772800,  "button_count": 6,  "infra_state": "active",  "provisioning_error": null,  "infra_attempted_at": 1719772830}
{  "detail": "auth required"}
{  "detail": {    "code": "domain_not_found",    "message": "Domain not found"  }}

Register a landing domain

Register a new landing domain. The row is returned immediately in the `pending` state and domain provisioning runs asynchronously. Requires a write-scoped key.

Delete a landing domain

Delete a domain and cascade-delete its buttons, segments, notification, and background assets, then deprovision its infrastructure. Requires a write-scoped key.