diff --git a/docs/api/customers/create_portal.md b/docs/api/customers/create_portal.md index 55b803a00..b85abf998 100644 --- a/docs/api/customers/create_portal.md +++ b/docs/api/customers/create_portal.md @@ -1,340 +1,384 @@ # Create Customer Portal - {% hint style="info" %} **Early Access Preview.** The customers API is currently in Alpha. We're actively developing it and seeking early feedback at [support@seam.co](mailto:support@seam.co). Expect breaking changes as we refine the design. {% endhint %} -* [Request Parameters](create_portal.md#request-parameters) -* [Response](create_portal.md#response) +- [Request Parameters](#request-parameters) +- [Response](#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. +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication). -
## Request Parameters -**`customer_data`** _Object_ +**`customer_data`** *Object*
-access_grants List +access_grants List List of access grants.
-*** +--- + +
-bookings List +bookings List List of bookings.
-*** +--- + +
-buildings List +buildings List List of buildings.
-*** +--- + +
-common_areas List +common_areas List List of shared common areas.
-*** +--- + +
-customer_key String +customer_key String Your unique identifier for the customer.
-*** +--- + +
-facilities List +facilities List List of gym or fitness facilities.
-*** +--- + +
-guests List +guests List List of guests.
-*** +--- + +
-listings List +listings List List of property listings.
-*** +--- + +
-properties List +properties List List of short-term rental properties.
-*** +--- + +
-property_listings List +property_listings List List of property listings.
-*** +--- + +
-reservations List +reservations List List of reservations.
-*** +--- + +
-residents List +residents List List of residents.
-*** +--- + +
-rooms List +rooms List List of hotel or hospitality rooms.
-*** +--- + +
-sites List +sites List List of general sites or areas.
-*** +--- + +
-spaces List +spaces List List of general spaces or areas.
-*** +--- + +
-staff_members List +staff_members List List of staff members.
-*** +--- + +
-tenants List +tenants List List of tenants.
-*** +--- + +
-units List +units List List of multi-family residential units.
-*** +--- + +
-user_identities List +user_identities List List of user identities.
-*** +--- + +
-users List +users List List of users.
-*** +--- -**`customization_profile_id`** _String_ + +**`customization_profile_id`** *String* The ID of the customization profile to use for the portal. -*** +--- -**`features`** _Object_ +**`features`** *Object*
-configure Object +configure Object Configuration for the configure feature.
-*** +--- + +
-connect Object +connect Object Configuration for the connect accounts feature.
-*** +--- + +
-manage Object +manage Object Configuration for the manage feature.
-*** +--- -
-manage_devices Object -### Configuration for the manage devices feature. +
+ +manage_devices Object -### deprecated: Use `manage` instead. +Configuration for the manage devices feature. +--- +deprecated: Use `manage` instead. +---
-*** +--- + +
-organize Object +organize Object Configuration for the organize feature.
-*** +--- -**`is_embedded`** _Boolean_ + +**`is_embedded`** *Boolean* Whether the portal is embedded in another application. -*** +--- -**`landing_page`** _Object_ +**`landing_page`** *Object* Configuration for the landing page when the portal loads.
-manage Object - - +manage Object
-*** - -**`locale`** _String_ - -The locale to use for the portal. +--- -*** -**`customer_resources_filters`** _List_ +**`locale`** *String* -Filter configuration for resources based on their `custom_metadata`. Each filter specifies a field, operation, and value to match against resource `custom_metadata`. When multiple filters are provided, a resource must match all of them (AND logic). Applies to both property listings and reservations. +The locale to use for the portal. -
+--- -Filter object structure +**`property_listing_filter`** *Object* -* **`field`** _String_ — The `custom_metadata` field name to filter on. Must start with a letter or underscore and contain only alphanumeric characters and underscores. -* **`operation`** _String_ — The comparison operation. Currently only `"="` is supported. -* **`value`** _String or Boolean_ — The value to compare against. +Filter configuration for property listings based on their custom_metadata. Keys and values must match the custom_metadata stored on property listings. -
+--- -*** ## Response {% hint style="success" %} -Returns: [**magic\_link**](../unstable_partner/building_blocks/) +Returns: +**[magic\_link](./../unstable_partner/building_blocks)** + {% endhint %} + {% tabs %} {% tab title="JSON" %} + + + ```json { "building_block_type": "connect_accounts", diff --git a/docs/device-guides/get-started-with-salto-locks.md b/docs/device-guides/get-started-with-salto-locks.md index 6bc92ffcc..367d59152 100644 --- a/docs/device-guides/get-started-with-salto-locks.md +++ b/docs/device-guides/get-started-with-salto-locks.md @@ -383,7 +383,11 @@ echo json_encode($locks); ### 4 — Locking & Unlocking a Door -Next, you can perform the basic action of locking and unlocking a door. Note that Salto disables this functionality by default and requires a special pass-through waiver via Seam. Seam automatically configures your IQ hubs to enable this functionality. Please contact us if you need to disable it. +Next, you can perform the basic action of locking and unlocking a door. + +{% hint style="warning" %} +Note that Salto KS disables this functionality by default and requires a special pass-through waiver via Seam. Please contact Seam to configure your IQ hubs to enable this functionality. +{% endhint %} {% openapi src="../.gitbook/assets/openapi (1).json" path="/locks/lock_door" method="post" %} [openapi (1).json](<../.gitbook/assets/openapi (1).json>)