v1

latestOpenAPI 3.0.02026-07-22201291.8 MB

Create Customer Portal

Creates a new customer portal magic link with configurable features.

post/customers/create_portal

Request body

customization_profile_idstring uuid

The ID of the customization profile to use for the portal.

exclude_locale_pickerboolean

Whether to exclude the option to select a locale within the portal UI.

is_embeddedboolean

Whether the portal is embedded in another application.

locale'en-US' | 'pt-PT' | 'fr-FR' | 'it-IT' | 'es-ES' | 'de-DE' | 'nl-NL' | 'el-GR' | 'pl-PL' | 'ru-RU'

The locale to use for the portal.

navigation_mode'full' | 'restricted'

Navigation mode for the portal. 'restricted' tells frontend to hide navigation UI, typically used for embedded deep links.

Response

OK