For AI agents: a machine-readable documentation index for this API is available at /llms.txt. Every page is also available as Markdown: append ".md" to the URL or send an "Accept: text/markdown" request header.

Connect a domain to a brand

Connects a custom domain to the brand, or replaces the one it has (a brand has at most one). The same rules as the app apply: the plan's brand page domain limit (403 forbidden with details.entitlement BRAND_PAGE_DOMAIN_LIMIT; Free allows none, Pro has no limit), a domain used by another brand or another part of Tarkle is 409 domain_taken, and the hosting provider can refuse it (422 domain_rejected) or be unavailable (503). Returns the domain with the DNS records to add at your DNS host, plus dns_provider (who hosts the DNS, found from the nameservers), dns_zone and dns_guide: the records named relative to the zone, numbered steps, and how to apply them with an API or MCP tool the person already has (Cloudflare, Vercel, Route 53 and others). An assistant with such a tool can add dns_guide.records itself and then poll getBrandDomain until status is active; without one it reads the steps to the person. Call getBrandDomain later to follow the setup. Sending the same domain again is safe. Needs brands:domains.

What you provide

  • Domain: A hostname such as brand.example.com (no path, port or spaces)

Do this with AI

I want to connect a domain to a brand. Use the Tarkle API. Read the reference for this operation and follow it exactly: https://project-03b42162.restlessdocs.com/endpoint/setbranddomain.md Authenticate with your API key as a Bearer token in the Authorization header. Then make the request for me and tell me what came back.

Paste this into Claude, Cursor, or any AI assistant and it will do it for you.