Remove a failed or released domain

remove_domain_from_list

Clears a domain whose registration failed, or that the workspace no longer holds, from the workspace's list.

POST /v1/remove_domain_from_listScopedomains:writeDestructive

A failed domain's registration did not go through and its payment was refunded, and removing it does not change that refund. A released domain is one the workspace no longer holds at the registrar. Any other domain is refused with Only a failed or released domain can be removed!, so it never touches a registration. Only the workspace owner can remove a domain. See Remove a failed or released domain.

Request

Call it with a POST to https://api.modulify.ai/v1/remove_domain_from_list, sending the inputs below as a JSON object. The token needs the domains:write scope.

This method is marked destructive: it deletes or overwrites data. Check the inputs before you call it, and send an Idempotency-Key header whenever you might retry it.

curl -X POST https://api.modulify.ai/v1/remove_domain_from_list \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"workspaceId":"WORKSPACE_ID","domainId":"DOMAIN_ID"}'

Over MCP, the same method is the remove_domain_from_list tool.

Inputs

Input Type Required Description
workspaceId string Yes The workspace that owns the domain.
domainId string Yes The _id of the failed or released domain, from list_bought_domains.

Response

Every call answers with the JSON envelope of success, message, data, code and version. data holds the result described above, and on a method that returns a total, count carries it. The response headers carry the call's X-Request-Id and what is left of your per-minute budget in X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset. Errors explains every status code a call can answer with.