Promote plugin to custom domain

Promote a plugin to a custom domain. This will create a new route for the plugin.

POST /api/public/v1/plugins/promote-to-custom-domain

Promote plugin to custom domain

cURL

curl --request POST \
  --url https://app.tagadapay.com/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"
}
'

200

success

{
  "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

200

application/json

Successful response