Skip to main content
POST
Creates a new customer portal magic link with configurable features.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
customer_data
object
customer_resources_filters
object[]

Filter configuration for resources based on their custom_metadata. Each filter specifies a field, operation, and value to match against resource custom_metadata.

customization_profile_id
string<uuid>

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

exclude_locale_picker
boolean
default:false

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

features
object

Features to include in the portal. Settings you omit use the portal's customization profile, then the Seam default. Settings you pass take precedence over the customization profile's, so changing the profile doesn't change them.

is_embedded
boolean
default:false

Whether the portal is embedded in another application.

landing_page
object

Configuration for the landing page when the portal loads.

locale
enum<string>

The locale to use for the portal.

Available options:
en-US,
pt-PT,
fr-FR,
it-IT,
es-ES,
de-DE,
nl-NL,
el-GR,
pl-PL,
ru-RU
navigation_mode
enum<string>
default:full

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

Available options:
full,
restricted
read_only
boolean
default:false

Whether the portal is read-only. When true, the customer can browse the portal but cannot perform any mutating action; write requests made with the portal's client session are rejected.

Response

200 - application/json

OK

customer_portal
object
required

Represents a Customer Portal. Customer Portal is a hosted, customizable interface for managing device access. It enables you to embed secure, pre-authenticated access flows into your product—either by sharing a link with users or embedding a view in an iframe. See the customer_portal object.