Skip to main content
POST
/
api
/
public
/
v1
/
plugins
/
promote-to-custom-domain
Promote plugin to custom domain
curl --request POST \
  --url https://app.localhost:3000/api/public/v1/plugins/promote-to-custom-domain \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pluginId": "sample-funnel-v1-abc123",
  "storeId": "store_123",
  "hostname": "checkout.example.com",
  "path": "/checkout"
}
'
{
  "success": true,
  "message": "Plugin promoted to custom domain successfully",
  "route": {
    "id": "route_123",
    "pluginId": "sample-funnel-v1-abc123",
    "storeId": "store_123",
    "hostname": "checkout.example.com",
    "path": "/checkout",
    "createdAt": "2024-03-20T10:30:00Z"
  }
}

Authorizations

​
Authorization
string
header
required

Enter your API key as: Bearer your-api-key

Body

application/json
​
deploymentId
string
required
​
customDomain
string
required
​
basePath
string
default:/

Response

Successful response