admin toolset
check_custom_domain
Check the custom domain. Checks the custom domain's DNS now and updates its status: active once it points at CareChannel and HTTPS works, else pending with what's missing. CareChannel also rechecks pending domains every few minutes. Nobody is emailed. Owners only.
- Toolset
- admin
- Who can call it
- Owners
- REST
POST /api/v1/w/{workspace}/settings/domain/check- Behavior
- changes dataidempotent
Input
No input.
Output
| Field | Type | Description |
|---|---|---|
namerequired | string | The workspace's name, shown on the portal and in emails. |
portal_settingsrequired | object | |
brandingrequired | object | |
emailrequired | object | How customer emails are sent: sender name and reply-to. |
custom_domainrequired | object or null | |
portal_urlrequired | string (uri) | |
versionrequired | integer |
Calling it
// MCP: tools/call
{ "name": "check_custom_domain", "arguments": {} }
// Typed client
await carechannel.check_custom_domain({});