Skip to main content

Activate Storefront Domain (v1)

Method & Path​

POST /api/v1/workspace/:workspaceId/storefront/domain/:domainId/activate

Description​

Activate a verified domain with active SSL certificate. This makes the domain live and accessible.

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": "active",
    "verificationToken": "google-site-verification=abc123",
    "sslStatus": "active",
    "createdAt": "2024-12-01T10:00:00.000Z",
    "updatedAt": "2024-12-01T12:00:00.000Z"
  }
}

Common Errors​

400 Bad Request: Domain not verified or SSL not active

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​

  • Domain must be verified and have active SSL certificate before activation
  • Once activated, domain status changes to active and becomes accessible
  • DNS must be properly configured for the domain to work