Hey, human!
HTTP/2 200 OK content-type: text/markdown; charset=utf-8 vary: accept, user-agent x-agent: [ai_agent]
Loading the agent response…
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.
https://tarkle.com/api/v1/brands/{brand}/domaincurl --request PUT \
--url https://tarkle.com/api/v1/brands/brand/domain \
--header 'Authorization: Bearer $API_KEY' \
--header 'Content-Type: application/json' \
--header 'X-Workspace-Key: X-Workspace-Key' \
--data '{"domain":"domain"}'Path parameters
brandstringrequiredBrand id (uuid) or slug
Query parameters
workspace_keystringThe same key as the X-Workspace-Key header, for clients that cannot set headers. Send one of the two, or both with the same value (different values are 400 conflicting_workspace)
Header parameters
X-Workspace-KeystringrequiredThe 8-character key of the workspace this call acts on; GET /workspaces lists the keys a token can use. A workspace id is refused (400 workspace_key_required)
Idempotency-KeystringMakes a write safe to repeat. Send a random value (a UUID is fine) of up to 255 visible characters. A repeat of the same request gets the first answer again, with the header `Idempotent-Replayed: true`, and does nothing twice. The same key for a different request is 422 `idempotency_key_reused`; the same request while the first one is still running is 409 `idempotency_in_progress`. A 5xx or 429 is not remembered, so retrying it runs the request again. Keys last 24 hours and belong to the account that created the token.
Body
application/jsonrequireddomainstringrequiredA hostname such as brand.example.com (no path, port or spaces)