Connect custom domain
setup_custom_domainConnect the user's own domain (e.g. www.example.com, example.com, or landing.example.com) to a Convika landing page.
Use when the user wants their page accessible on their own domain instead of {subdomain}.convika.page (独自ドメイン, 自分のドメインでホームページ・ランディングページを公開). Returns the CNAME record for routing and TXT record for ownership verification. After DNS setup, SSL is automatically provisioned.
Available on all plans. Free: 1 custom domain, Pro/MAX: unlimited.
Standard flow: connect a www site first, then ask the user to add the returned CNAME and TXT records.
example.com and www.example.com connect the same pair: www.example.com is the site that serves the page, and example.com redirects to it (301, path and query kept) once its A record points at Convika. guidance.rootRedirect lists the records to add (A @ to Convika's IPv4, CNAME www, TXT) and any to delete. The pair counts as one domain. If example.com already shows another site, Convika connects only www and leaves example.com alone (guidance.rootRedirect says so). If the response has guidance.rootNotServed instead, example.com won't open the page: tell the user to share the www URL. Do not start a DNS-provider discussion during initial setup.
If the tool returns domain_provider_error, tell the user this is a Convika-side provider provisioning failure. Do not tell the user to wait for DNS propagation or change DNS records until Convika fixes the provider error.
If the tool returns invalid_hostname, the site itself can't be used (for example, reserved names such as anything.example.com). Ask the user for a site on a domain they own and call this tool again with it.
A value with a path (www.example.com/lp) returns path_not_supported: call set_site_url with the full URL instead.
If guidance.existingSite is present, another site shows there now and connecting would replace that whole site. Tell the user before any DNS change, as the text says.
Call get_domain_status to check verification progress after DNS setup
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| siteId | Yes | The ID of the page to add a custom domain to | |
| hostname | Yes | The custom domain hostname (e.g. 'www.example.com' or 'landing.example.com'). A root such as 'example.com' connects 'www.example.com'. |