Settings of the hosted customer portal.
Get customer-portal settings
Returns the org's customer-portal feature toggles as they resolve on the settings ladder (portal.* keys): the org's own value, a parent's it inherits, or the default (true).
Required scope: portal.read (Read portal settings).
Headers
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Get customer-portal settings › Responses
OK
Create or update customer-portal settings
Deprecated: use PATCH /portal-settings instead. Removed on 2026-11-30.
Saves the org's customer-portal feature toggles on the settings ladder (portal.* keys), at the organization level. Omitted fields are not written and keep the value they resolve to. A parent organization's lock refuses the save (409); a sandbox workspace cannot save organization-level settings (422, switch to the live workspace). Use PATCH /portal-settings instead.
Required scope: portal.write (Manage portal settings).
Headers
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Create or update customer-portal settings › Request Body
allow_add_payment_methodallow_cancel_subscriptionallow_invoice_payallow_wallet_topupshow_billing_settingsshow_invoicesshow_payment_methodsshow_subscriptionsshow_walletsCreate or update customer-portal settings › Responses
OK
Update customer-portal settings
Saves the org's customer-portal feature toggles on the settings ladder (portal.* keys), at the organization level. Omitted fields are not written and keep the value they resolve to. A parent organization's lock refuses the save (409); a sandbox workspace cannot save organization-level settings (422, switch to the live workspace).
Required scope: portal.write (Manage portal settings).
Headers
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Update customer-portal settings › Request Body
allow_add_payment_methodallow_cancel_subscriptionallow_invoice_payallow_wallet_topupshow_billing_settingsshow_invoicesshow_payment_methodsshow_subscriptionsshow_walletsUpdate customer-portal settings › Responses
OK