Create Customer Portal

• Request Parameters

• Response

Creates a new customer portal magic link with configurable features.

Authentication Methods

• API key

• Personal access token Must also include the seam-workspace header in the request.

To learn more, see Authentication.

Request Parameters

customer_data Object

access_grants List

List of access grants.

---

bookings List

List of bookings.

---

buildings List

List of buildings.

---

common_areas List

List of shared common areas.

---

customer_key String

Your unique identifier for the customer.

---

facilities List

List of gym or fitness facilities.

---

guests List

List of guests.

---

listings List

List of property listings.

---

properties List

List of short-term rental properties.

---

property_listings List

List of property listings.

---

reservations List

List of reservations.

---

residents List

List of residents.

---

rooms List

List of hotel or hospitality rooms.

---

sites List

List of general sites or areas.

---

spaces List

List of general spaces or areas.

---

staff_members List

List of staff members.

---

tenants List

List of tenants.

---

units List

List of multi-family residential units.

---

user_identities List

List of user identities.

---

users List

List of users.

---

customer_resources_filters Array of Objects

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

field String

The custom_metadata field name to filter on.

---

operation Enum

The comparison operation. Currently only '=' is supported.

Enum values:

• =

---

value Object

The value to compare against.

---

customization_profile_id String

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

---

exclude_locale_picker Boolean

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

---

features Object

configure Object

Configuration for the configure feature.

---

connect Object

Configuration for the connect accounts feature.

---

manage Object

Configuration for the manage feature.

---

manage_devices Object

Configuration for the manage devices feature.

deprecated: Use manage instead.

---

organize Object

Configuration for the organize feature.

---

is_embedded Boolean

Whether the portal is embedded in another application.

---

landing_page Object

Configuration for the landing page when the portal loads.

manage Object

---

locale String

The locale to use for the portal.

---

navigation_mode String

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

---

Response

Returns: customer_portal

JSON

{
  "created_at": "2025-06-16T16:54:17.946594Z",
  "customer_key": "My Company",
  "expires_at": "2025-06-17T16:54:17.946594Z",
  "url": "https://se.am/1234",
  "workspace_id": "67c58f1f-f148-4415-a63c-dc6c145c6b91"
}