Domains

Enable or disable custom domains

Turns custom domains on or off for the website — the billing moment. Enabling makes it a billable site on the plan (first included with Pro, additional sites charged per site, prorated); disabling stops that charge with a prorated credit and disconnects every custom domain on the website. Owner-only. When paymentUrl is returned nothing changed: complete checkout there, then call again. With allowPurchase: false, enabling fails with 409 purchase_required instead of adding a charge. Trashing a website disables custom domains automatically.

post/websites/{websiteId}/domains/enablement

Request

  • Base URL: https://api.cactal.ai/v1
  • URL: https://api.cactal.ai/v1/websites/{websiteId}/domains/enablement
  • Auth: HTTP bearer

Path parameters

websiteIdstring required

Request body

enabledboolean required
successUrlstring
allowPurchaseboolean

Response

The enablement state after the call.

enabledboolean required

Whether custom domains are enabled for the website after this call.

paymentUrlstring nullable required

Hosted checkout URL when enabling needs a payment step; custom domains stay disabled until checkout completes and the call is retried. null when applied directly.

Changes

No recorded changes to this operation across all 1 revision of this API.