{
"customer_portal": {
"created_at": "2023-11-07T05:31:56Z",
"customer_key": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"url": "<string>",
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}Create Customer Portal
Creates a new customer portal magic link with configurable features. Seam API reference: POST /customers/create_portal.
{
"customer_portal": {
"created_at": "2023-11-07T05:31:56Z",
"customer_key": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"url": "<string>",
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Filter configuration for resources based on their custom_metadata. Each filter specifies a field, operation, and value to match against resource custom_metadata.
Show child attributes
Show child attributes
The ID of the customization profile to use for the portal.
Whether to exclude the option to select a locale within the portal UI.
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.
Show child attributes
Show child attributes
Whether the portal is embedded in another application.
Configuration for the landing page when the portal loads.
Show child attributes
Show child attributes
The locale to use for the portal.
en-US, pt-PT, fr-FR, it-IT, es-ES, de-DE, nl-NL, el-GR, pl-PL, ru-RU Navigation mode for the portal. 'restricted' tells frontend to hide navigation UI, typically used for embedded deep links.
full, restricted 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.
Show child attributes
Show child attributes
Response
OK
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.
Show child attributes
Show child attributes
Was this page helpful?