Skip to main content

Disable Storefront Domain (v1)

Method & Path​

PATCH /api/v1/workspace/:workspaceId/storefront/domain/:domainId/disable

Description​

Disable a custom domain. This temporarily makes the domain inactive without deleting it.

Authentication​

Required: Workspace authentication. User must be authenticated as Workspace Owner or Staff with store.manage permission.

Headers​

Authorization: Bearer <workspace_token>
Content-Type: application/json

Path Parameters​

ParameterTypeRequiredDescription
workspaceIdstringYesWorkspace identifier
domainIdstringYesDomain identifier

Response 200 OK​

{
  "domain": {
    "id": "507f1f77bcf86cd799439011",
    "workspaceId": "507f1f77bcf86cd799439012",
    "domain": "example.com",
    "status": "disabled",
    "verificationToken": "google-site-verification=abc123",
    "sslStatus": "active",
    "createdAt": "2024-12-01T10:00:00.000Z",
    "updatedAt": "2024-12-01T13:00:00.000Z"
  }
}

Common Errors​

401 Unauthorized: Missing or invalid authentication token

403 Forbidden: User does not have store.manage permission

404 Not Found: Workspace or domain not found

500 Internal Server Error: Server error occurred while processing the request

Notes​

  • Disabled domains can be reactivated using Activate Domain endpoint
  • Disabling a domain does not delete DNS records or SSL certificate
  • Domain can be permanently deleted using Delete Domain endpoint