Remove a custom domain

Release the hostname's claim in Topolo Web's hostname registry (Web deletes its edge hostname and Turnstile membership; a claim already gone counts as released), then delete the domain. The job board stays published at its Recruit address. The organization can then remove the DNS records. Recruiters with workspace:delete only.

Outcome

Before you start

Verify identity and the pinned organization context, then discover the exact action and a granted Recruit workspace.
The required application permission is workspace:delete. Hiring-team roles and record visibility are enforced separately; a workspace grant alone does not grant every Recruit action.
Organization and workspace identity come from verified context. Pass the workspace as resourceType/resourceId, separate from action input; request-body organizationId/workspaceId values cannot select an authorized scope.
The first authorized action can initialize an identity-only workspace mirror and invoke the configured workspace-created callback. It does not create an Auth workspace or grant new access.

Recruiters can perform the full hiring workflow. Hiring managers see their managed roles and candidates; interviewers see assigned interviews and their candidates. Workspace owners and organization administrators act as recruiters. Use team.me to read the caller's effective role and allowed actions.

Discover the target

topolo whoami --json
topolo actions get app_topolo_recruit.domains.delete --detail --json
topolo resources topolo-recruit --json
topolo workspaces list topolo-recruit --json
topolo actions get app_topolo_recruit.team.me --detail --json

Request

POST /api/domains/{id}/delete

Save input as payload.json. CLI and MCP action input includes path identifiers. The reviewed plan separates path/query fields from the HTTP body. Set RECRUIT_WORKSPACE_ID from granted resource discovery.

Inspect and test this action in the signed action console. Use its discovered schema and plan; a test response still requires the verification described below.

Input fields

Field	Required	Type	Constraints
`id`	Required	string	{"minLength":1,"maxLength":64}

Exact input schema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

Effects

Releases the hostname at Web and deletes the domain; the board stops answering on it.

Interpret the response

Call domains.list and confirm the domain is absent.

The response identifier path is $.deleted.id for custom_domain. Lists may be empty; an empty list is not a discovered target.

Exact success schema:

{
  "type": "object",
  "required": [
    "deleted"
  ],
  "properties": {
    "deleted": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "hostname": {
          "type": "string"
        }
      }
    }
  }
}

Worked examples

Actual dispatcher and migration-created SQLite or Worker handlers; Auth/workspace identity, object storage, mail and Notify dependencies are simulated. These synthetic fixtures establish no live authorization or delivery. A synthetic fixture identifier grants no access. Validate and inspect the planned request before executing. Commands with --confirm or MCP confirm:true assume the intended effect or data export has already been authorized.

Successful request

Actual dispatcher and migration-created SQLite; verified Auth/workspace context, object storage, mail and Notify dependencies are simulated. No live delivery or credential authorization is established. This complete response is a local fixture, not a deployed or delivered result.

Input · payload.json:

{
  "id": "dom_849761f3a945459892f879232a6795e5"
}

CLI:

topolo actions validate app_topolo_recruit.domains.delete --data @payload.json --json
topolo actions plan app_topolo_recruit.domains.delete --resource-type workspace --resource-id "$RECRUIT_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_recruit.domains.delete --resource-type workspace --resource-id "$RECRUIT_WORKSPACE_ID" --data @payload.json --confirm --json

MCP tool and arguments:

{
  "tool": "topolo_call_action",
  "arguments": {
    "actionId": "app_topolo_recruit.domains.delete",
    "input": {
      "id": "dom_849761f3a945459892f879232a6795e5"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 200:

{
  "deleted": {
    "id": "dom_849761f3a945459892f879232a6795e5",
    "hostname": "careers.example.com"
  }
}

HTTP 200. Call domains.list and confirm the domain is absent.

Another supported request

Input · payload.json:

{
  "id": "dom_c556b5280dd74788b7066821d1003874"
}

CLI:

topolo actions validate app_topolo_recruit.domains.delete --data @payload.json --json
topolo actions plan app_topolo_recruit.domains.delete --resource-type workspace --resource-id "$RECRUIT_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_recruit.domains.delete --resource-type workspace --resource-id "$RECRUIT_WORKSPACE_ID" --data @payload.json --confirm --json

MCP tool and arguments:

{
  "tool": "topolo_call_action",
  "arguments": {
    "actionId": "app_topolo_recruit.domains.delete",
    "input": {
      "id": "dom_c556b5280dd74788b7066821d1003874"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 200:

{
  "deleted": {
    "id": "dom_c556b5280dd74788b7066821d1003874",
    "hostname": "careers.example.com"
  }
}

HTTP 200. Call domains.list and confirm the domain is absent.

Another supported request

Input · payload.json:

{
  "id": "dom_aa3f81d4d7144d8c8952f6059c8ba4c4"
}

CLI:

topolo actions validate app_topolo_recruit.domains.delete --data @payload.json --json
topolo actions plan app_topolo_recruit.domains.delete --resource-type workspace --resource-id "$RECRUIT_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_recruit.domains.delete --resource-type workspace --resource-id "$RECRUIT_WORKSPACE_ID" --data @payload.json --confirm --json

MCP tool and arguments:

{
  "tool": "topolo_call_action",
  "arguments": {
    "actionId": "app_topolo_recruit.domains.delete",
    "input": {
      "id": "dom_aa3f81d4d7144d8c8952f6059c8ba4c4"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 200:

{
  "deleted": {
    "id": "dom_aa3f81d4d7144d8c8952f6059c8ba4c4",
    "hostname": "careers.example.com"
  }
}

HTTP 200. Call domains.list and confirm the domain is absent.

Another supported request

Input · payload.json:

{
  "id": "dom_e44dbed60f2b44ac8323cae072140f9d"
}

CLI:

topolo actions validate app_topolo_recruit.domains.delete --data @payload.json --json
topolo actions plan app_topolo_recruit.domains.delete --resource-type workspace --resource-id "$RECRUIT_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_recruit.domains.delete --resource-type workspace --resource-id "$RECRUIT_WORKSPACE_ID" --data @payload.json --confirm --json

MCP tool and arguments:

{
  "tool": "topolo_call_action",
  "arguments": {
    "actionId": "app_topolo_recruit.domains.delete",
    "input": {
      "id": "dom_e44dbed60f2b44ac8323cae072140f9d"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 200:

{
  "deleted": {
    "id": "dom_e44dbed60f2b44ac8323cae072140f9d",
    "hostname": "careers.example.com"
  }
}

HTTP 200. Call domains.list and confirm the domain is absent.

Refused request · not_found

Input · payload.json:

{
  "id": "dom_other"
}

CLI:

topolo actions validate app_topolo_recruit.domains.delete --data @payload.json --json
topolo actions plan app_topolo_recruit.domains.delete --resource-type workspace --resource-id "$RECRUIT_WORKSPACE_ID" --data @payload.json --json

Captured local response · HTTP 404:

{
  "error": {
    "code": "not_found",
    "message": "Custom domain was not found in this workspace.",
    "messageKey": "recruit.api.notFound.customDomain",
    "locale": "en"
  }
}

HTTP 404. Preserve the exact response code and details. Do not claim success.

Refused request · custom_domains_unconfigured

Input · payload.json:

{
  "id": "dom_claimed"
}

CLI:

topolo actions validate app_topolo_recruit.domains.delete --data @payload.json --json
topolo actions plan app_topolo_recruit.domains.delete --resource-type workspace --resource-id "$RECRUIT_WORKSPACE_ID" --data @payload.json --json

Captured local response · HTTP 409:

{
  "error": {
    "code": "custom_domains_unconfigured",
    "message": "Custom domains are not available in this environment yet.",
    "messageKey": "recruit.api.errors.customDomainsUnconfigured",
    "locale": "en"
  }
}

HTTP 409. Preserve the exact response code and details. Do not claim success.

Refused request · hiring_team_role_required

Input · payload.json:

{
  "id": "dom_x"
}

CLI:

topolo actions validate app_topolo_recruit.domains.delete --data @payload.json --json
topolo actions plan app_topolo_recruit.domains.delete --resource-type workspace --resource-id "$RECRUIT_WORKSPACE_ID" --data @payload.json --json

Captured local response · HTTP 403:

{
  "error": {
    "code": "hiring_team_role_required",
    "message": "Your hiring-team role in this workspace does not allow this action.",
    "messageKey": "recruit.api.errors.teamRoleRequired",
    "locale": "en",
    "details": {
      "teamRole": "interviewer",
      "allowedRoles": [
        "recruiter"
      ]
    }
  }
}

HTTP 403. Preserve the exact response code and details. Do not claim success.

Refused request · registry_unavailable

Input · payload.json:

{
  "id": "dom_f060e6ca46be4595b03243b3844badb1"
}

CLI:

topolo actions validate app_topolo_recruit.domains.delete --data @payload.json --json
topolo actions plan app_topolo_recruit.domains.delete --resource-type workspace --resource-id "$RECRUIT_WORKSPACE_ID" --data @payload.json --json

Captured local response · HTTP 503:

{
  "error": {
    "code": "registry_unavailable",
    "message": "Custom domains cannot be connected right now. Nothing was lost; try again shortly.",
    "messageKey": "recruit.api.errors.registryUnavailable",
    "locale": "en"
  }
}

HTTP 503. Preserve the exact response code and details. Do not claim success.

Verify the result

Call domains.list and confirm the domain is absent.

Errors and recovery

organization_context_required (HTTP 403): Select the organization authorized by the credential; do not send an organization id in the action input.
permission_denied (HTTP 403): Grant the credential the required Recruit workspace permission.
hiring_team_role_required (HTTP 403): Ask a recruiter to give the caller a hiring-team role that allows this action (team.members.set); error.details lists the allowed roles.
workspace_required (HTTP 409): Create a Recruit workspace, or pass the workspace resource context.
invalid_input (HTTP 422): Correct the fields named in error.details using inputSchema, then retry.
not_found (HTTP 404): List custom domains with domains.list to find a valid id. Records outside the caller's hiring-team view also answer 404.
invalid_hostname (HTTP 422): Send a hostname such as www.example.com (letters, digits, hyphens and dots; no scheme or path).
hostname_reserved (HTTP 422): Use a hostname on the organization's own domain, not a reserved hosting-platform hostname (Topolo platform zones, workers.dev, pages.dev).
hostname_taken (HTTP 409): Another workspace or application holds this hostname. Choose another hostname; do not retry.
custom_domains_unconfigured (HTTP 409): Custom domains are not available in this environment yet. Keep the domain and retry later; nothing was changed.
dns_records_missing (HTTP 409): Publish the TXT ownership record named in the error (the guide.records of the domain), wait a few minutes for DNS, then verify again.
ownership_unverified (HTTP 409): Web could not confirm the ownership record yet. Wait for DNS to update, then verify again.
custom_domain_capacity_reached (HTTP 409): No custom-domain capacity is left; nothing was claimed and the domain is kept. Verify again later or escalate to the platform.
dns_lookup_failed (HTTP 502): The domain's DNS records could not be read. Retry shortly.
registry_rejected (HTTP 502): The hostname registry rejected the claim. Retry shortly; if it persists, report the request id.
registry_unavailable (HTTP 503): The hostname registry could not be reached; nothing was lost. Retry shortly.
domain_connection_failed (HTTP 422): The domain could not be connected. Check the hostname and try again.
invalid_json (HTTP 400): Send a valid JSON object. The request is rejected before workspace resolution or record creation.
api_key_workspace_binding_required (HTTP 403): Create the API key bound to a workspace (an organization-wide key names a workspace nobody verified), then call again.
workspace_required (HTTP 400): Send the workspace the key is bound to with --resource-type workspace --resource-id <workspace id> (or the X-Topolo-Resource-Type and X-Topolo-Resource-Id headers).
workspace_forbidden (HTTP 403): Use a workspace the key is bound to; read the key's bindings in API key management.
workspace_access_insufficient (HTTP 403): Give the key the workspace permission this action needs: workspace:read to read and workspace:write to change. A delete also needs workspace:write, because the write permission is what grants the read_write level.

Authentication or gateway failures may occur before the Recruit handler. Preserve the exact discovered service error, request id and credential context. The local fixtures do not establish live credential authorization.

Recovery boundary

Add the hostname again with domains.create (a new ownership token: update the TXT record), then domains.verify.

Evidence

Actual dispatcher and migration-created SQLite or Worker handlers; Auth/workspace identity, object storage, mail and Notify dependencies are simulated. These synthetic fixtures establish no live authorization or delivery. Test capture provenance is retained with each fixture. API, database and integration outcomes require separate verification in the target environment.

Documentation history

2026-10-18: Added this action guide with reviewed request, response, permission, verification and recovery guidance from source 63171ed7c08aa066adb44cc01e64011e465302e1. Examples are retained local captures, not production execution or delivery proof.