Skip to main content
POST
Claim a platform subdomain

Authorizations

X-API-Key
string
header
required

Your API key, for example dlk_live_.... Create one in the dashboard under Settings → API Keys. Keys are shown once at creation and stored only as a hash, so they cannot be recovered.

Body

application/x-www-form-urlencoded
subdomain_slug
string
required

The left-most label to claim under parent_domain (2–63 chars, lowercase a-z0-9 and hyphens). The final host is {slug}.{parent_domain}.

parent_domain
string
required

The verified system parent domain (by id) under which to claim a platform subdomain. Required.

What the domain is for: Shortlinks or Dynamic Links. Defaults to Shortlinks.

Response

Success.

data
object

The endpoint's payload.