Set the Custom Domain
helpcenter_set_custom_domainConnect the help center to the user's own domain (e.g. help.example.com), as its Settings page does. Then give the user the DNS record from the result to add at their DNS provider; the certificate is requested once the record points here, and the domain goes live minutes later. Follow it with helpcenter_get_custom_domain.
Works once the user has claimed the help center, verified their email address and activated a plan; until then it answers capability_locked with the user's next step (helpcenter_get_help_center shows it too).
Changing to a new domain counts against the help center's 4 changes a month and stops the old domain answering: only set the domain the user asked for. Setting the domain it already has changes nothing. Refused when another help center already holds the domain (domain_taken).
Args:
domain (string, required): a host name, without http(s):// or a path.
Returns: { custom_domain } as helpcenter_get_custom_domain answers it.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| domain | Yes | The user's host name for the help center, like 'help.example.com': no http(s)://, no path. A leading 'www.' is dropped. | |
| agent_key | Yes | The api_key helpcenter_create_help_center returned for this help center, exactly as returned. Required on every call: this endpoint has no sign-in, so the key is how each call says which help center it acts on. It is sent to HelpCenter.io as this call's credential and nowhere else, and it is never shown again: keep it for the whole task, and never show it to the user or write it into content. |