Skip to main content
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"
  },
  "magic_link": {
    "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"
  },
  "ok": true
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Configuration for a customer portal

​
_dev
boolean
default:false

Whether the portal is in developer mode. Only available for Seam employees.

​
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.

​
deep_link
object

Deep link target resource for initial redirect. When set, the portal will navigate directly to the specified resource.

​
exclude_locale_picker
boolean
default:false

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

​
features
object
​
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
​
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
​
customer_data
object

Response

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.

​
magic_link
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.

​
ok
boolean
required