@seamapi/http - v2.41.0
    Preparing search index...

    Type Alias CustomersCreatePortalParameters

    type CustomersCreatePortalParameters = {
        customer_data?: {
            access_grants?: {
                access_grant_key?: string;
                building_keys?: string[];
                common_area_keys?: string[];
                ends_at?: string | Date | Temporal.Instant;
                facility_keys?: string[];
                guest_key?: string;
                listing_keys?: string[];
                name?: string;
                preferred_code?: string | null;
                property_keys?: string[];
                resident_key?: string;
                room_keys?: string[];
                space_keys?: string[];
                starts_at?: string | Date | Temporal.Instant;
                tenant_key?: string;
                unit_keys?: string[];
                user_identity_key?: string;
                user_key?: string;
            }[];
            bookings?: {
                booking_key?: string;
                building_keys?: string[];
                common_area_keys?: string[];
                ends_at?: string
                | Date
                | Temporal.Instant;
                facility_keys?: string[];
                guest_key?: string;
                listing_keys?: string[];
                name?: string;
                preferred_code?: string | null;
                property_keys?: string[];
                resident_key?: string;
                room_keys?: string[];
                space_keys?: string[];
                starts_at?: string | Date | Temporal.Instant;
                tenant_key?: string;
                unit_keys?: string[];
                user_identity_key?: string;
                user_key?: string;
            }[];
            buildings?: { building_key?: string; name?: string }[];
            common_areas?: {
                common_area_key?: string;
                name?: string;
                parent_site_key?: string;
            }[];
            customer_key?: string;
            customization_profile_id?: string
            | null;
            facilities?: { facility_key?: string; name?: string }[];
            guests?: {
                email_address?: string;
                guest_key?: string;
                name?: string;
                phone_number?: string;
            }[];
            listings?: { listing_key?: string; name?: string }[];
            low_battery_alert_threshold?: number | null;
            properties?: { name?: string; property_key?: string }[];
            property_listings?: {
                custom_metadata?: Record<string, string | boolean>;
                name?: string;
                property_listing_key?: string;
            }[];
            reservations?: {
                building_keys?: string[];
                common_area_keys?: string[];
                custom_metadata?: Record<string, string | boolean>;
                ends_at?: string | Date | Temporal.Instant;
                facility_keys?: string[];
                guest_key?: string;
                listing_keys?: string[];
                name?: string;
                preferred_code?: string | null;
                property_keys?: string[];
                reservation_key?: string;
                resident_key?: string;
                room_keys?: string[];
                space_keys?: string[];
                starts_at?: string | Date | Temporal.Instant;
                tenant_key?: string;
                unit_keys?: string[];
                user_identity_key?: string;
                user_key?: string;
            }[];
            residents?: {
                email_address?: string;
                name?: string;
                phone_number?: string;
                resident_key?: string;
            }[];
            rooms?: { name?: string; parent_site_key?: string; room_key?: string }[];
            sites?: { name?: string; site_key?: string }[];
            spaces?: {
                customer_data?: {
                    address?: string | null;
                    default_checkin_time?: string | null;
                    default_checkout_time?: string | null;
                    time_zone?: string | null;
                };
                duration_minutes?: number;
                geolocation?: { latitude?: number; longitude?: number };
                name?: string;
                parent_site_key?: string;
                space_key?: string;
            }[];
            staff_members?: {
                building_keys?: string[];
                common_area_keys?: string[];
                email_address?: string;
                facility_keys?: string[];
                listing_keys?: string[];
                name?: string;
                phone_number?: string;
                property_keys?: string[];
                property_listing_keys?: string[];
                room_keys?: string[];
                site_keys?: string[];
                space_keys?: string[];
                staff_member_key?: string;
                unit_keys?: string[];
            }[];
            tenants?: {
                email_address?: string;
                name?: string;
                phone_number?: string;
                tenant_key?: string;
            }[];
            units?: { name?: string; parent_site_key?: string; unit_key?: string }[];
            user_identities?: {
                email_address?: string;
                name?: string;
                phone_number?: string;
                user_identity_key?: string;
            }[];
            users?: {
                email_address?: string;
                name?: string;
                phone_number?: string;
                user_key?: string;
            }[];
        };
        customer_resources_filters?: {
            field?: string;
            operation?: "=";
            value?: string;
        }[];
        customization_profile_id?: string;
        deep_link?: {
            resource_id?: string;
            resource_key?: string;
            resource_type?: "reservation"
            | "space"
            | "device"
            | "acs_entrance";
        };
        exclude_locale_picker?: boolean;
        features?: {
            configure?: {
                allow_access_automation_rule_customization?: boolean;
                allow_climate_automation_rule_customization?: boolean;
                allow_instant_key_customization?: boolean;
                allow_notification_customization?: boolean;
                allow_sound_automation_rule_customization?: boolean;
                exclude?: boolean;
            };
            connect?: {
                accepted_providers?: string[];
                exclude?: boolean;
                excluded_providers?: string[];
            };
            manage?: {
                device_management_confirmation?: {
                    body?: string;
                    cancel_button_label?: string;
                    confirm_button_label?: string;
                    title?: string;
                };
                events?: { allowed_events?: string[]; default_events?: string[] };
                exclude?: boolean;
                exclude_device_management?: boolean;
                exclude_reservation_management?: boolean;
                exclude_reservation_technical_details?: boolean;
                exclude_staff_management?: boolean;
            };
            manage_devices?: { exclude?: boolean };
            organize?: { exclude?: boolean };
        };
        is_embedded?: boolean;
        landing_page?: {
            manage?: {
                access_grant_key?: string;
                booking_key?: string;
                building_key?: string;
                common_area_key?: string;
                facility_key?: string;
                listing_key?: string;
                property_key?: string;
                property_listing_key?: string;
                reservation_key?: string;
                room_key?: string;
                site_key?: string;
                space_key?: string;
                unit_key?: string;
            };
        };
        locale?: | "en-US"
        | "pt-PT"
        | "fr-FR"
        | "it-IT"
        | "es-ES"
        | "de-DE"
        | "nl-NL"
        | "el-GR"
        | "pl-PL"
        | "ru-RU";
        navigation_mode?: "full"
        | "restricted";
        read_only?: boolean;
    }
    Index
    customer_data? customer_resources_filters? customization_profile_id? deep_link? exclude_locale_picker? features? is_embedded? landing_page? locale? navigation_mode? read_only?
    customer_data?: {
        access_grants?: {
            access_grant_key?: string;
            building_keys?: string[];
            common_area_keys?: string[];
            ends_at?: string | Date | Temporal.Instant;
            facility_keys?: string[];
            guest_key?: string;
            listing_keys?: string[];
            name?: string;
            preferred_code?: string | null;
            property_keys?: string[];
            resident_key?: string;
            room_keys?: string[];
            space_keys?: string[];
            starts_at?: string | Date | Temporal.Instant;
            tenant_key?: string;
            unit_keys?: string[];
            user_identity_key?: string;
            user_key?: string;
        }[];
        bookings?: {
            booking_key?: string;
            building_keys?: string[];
            common_area_keys?: string[];
            ends_at?: string
            | Date
            | Temporal.Instant;
            facility_keys?: string[];
            guest_key?: string;
            listing_keys?: string[];
            name?: string;
            preferred_code?: string | null;
            property_keys?: string[];
            resident_key?: string;
            room_keys?: string[];
            space_keys?: string[];
            starts_at?: string | Date | Temporal.Instant;
            tenant_key?: string;
            unit_keys?: string[];
            user_identity_key?: string;
            user_key?: string;
        }[];
        buildings?: { building_key?: string; name?: string }[];
        common_areas?: {
            common_area_key?: string;
            name?: string;
            parent_site_key?: string;
        }[];
        customer_key?: string;
        customization_profile_id?: string
        | null;
        facilities?: { facility_key?: string; name?: string }[];
        guests?: {
            email_address?: string;
            guest_key?: string;
            name?: string;
            phone_number?: string;
        }[];
        listings?: { listing_key?: string; name?: string }[];
        low_battery_alert_threshold?: number | null;
        properties?: { name?: string; property_key?: string }[];
        property_listings?: {
            custom_metadata?: Record<string, string | boolean>;
            name?: string;
            property_listing_key?: string;
        }[];
        reservations?: {
            building_keys?: string[];
            common_area_keys?: string[];
            custom_metadata?: Record<string, string | boolean>;
            ends_at?: string | Date | Temporal.Instant;
            facility_keys?: string[];
            guest_key?: string;
            listing_keys?: string[];
            name?: string;
            preferred_code?: string | null;
            property_keys?: string[];
            reservation_key?: string;
            resident_key?: string;
            room_keys?: string[];
            space_keys?: string[];
            starts_at?: string | Date | Temporal.Instant;
            tenant_key?: string;
            unit_keys?: string[];
            user_identity_key?: string;
            user_key?: string;
        }[];
        residents?: {
            email_address?: string;
            name?: string;
            phone_number?: string;
            resident_key?: string;
        }[];
        rooms?: { name?: string; parent_site_key?: string; room_key?: string }[];
        sites?: { name?: string; site_key?: string }[];
        spaces?: {
            customer_data?: {
                address?: string | null;
                default_checkin_time?: string | null;
                default_checkout_time?: string | null;
                time_zone?: string | null;
            };
            duration_minutes?: number;
            geolocation?: { latitude?: number; longitude?: number };
            name?: string;
            parent_site_key?: string;
            space_key?: string;
        }[];
        staff_members?: {
            building_keys?: string[];
            common_area_keys?: string[];
            email_address?: string;
            facility_keys?: string[];
            listing_keys?: string[];
            name?: string;
            phone_number?: string;
            property_keys?: string[];
            property_listing_keys?: string[];
            room_keys?: string[];
            site_keys?: string[];
            space_keys?: string[];
            staff_member_key?: string;
            unit_keys?: string[];
        }[];
        tenants?: {
            email_address?: string;
            name?: string;
            phone_number?: string;
            tenant_key?: string;
        }[];
        units?: { name?: string; parent_site_key?: string; unit_key?: string }[];
        user_identities?: {
            email_address?: string;
            name?: string;
            phone_number?: string;
            user_identity_key?: string;
        }[];
        users?: {
            email_address?: string;
            name?: string;
            phone_number?: string;
            user_key?: string;
        }[];
    }

    Type Declaration

    • Optionalaccess_grants?: {
          access_grant_key?: string;
          building_keys?: string[];
          common_area_keys?: string[];
          ends_at?: string | Date | Temporal.Instant;
          facility_keys?: string[];
          guest_key?: string;
          listing_keys?: string[];
          name?: string;
          preferred_code?: string | null;
          property_keys?: string[];
          resident_key?: string;
          room_keys?: string[];
          space_keys?: string[];
          starts_at?: string | Date | Temporal.Instant;
          tenant_key?: string;
          unit_keys?: string[];
          user_identity_key?: string;
          user_key?: string;
      }[]

      List of access grants.

    • Optionalbookings?: {
          booking_key?: string;
          building_keys?: string[];
          common_area_keys?: string[];
          ends_at?: string | Date | Temporal.Instant;
          facility_keys?: string[];
          guest_key?: string;
          listing_keys?: string[];
          name?: string;
          preferred_code?: string | null;
          property_keys?: string[];
          resident_key?: string;
          room_keys?: string[];
          space_keys?: string[];
          starts_at?: string | Date | Temporal.Instant;
          tenant_key?: string;
          unit_keys?: string[];
          user_identity_key?: string;
          user_key?: string;
      }[]

      List of bookings.

    • Optionalbuildings?: { building_key?: string; name?: string }[]

      List of buildings.

    • Optionalcommon_areas?: { common_area_key?: string; name?: string; parent_site_key?: string }[]

      List of shared common areas.

    • Optionalcustomer_key?: string

      Your unique identifier for the customer.

    • Optionalcustomization_profile_id?: string | null

      ID of the customization profile to use for this customer. Access grants that automations create for this customer use this profile. Pass null to remove the customer's customization profile.

    • Optionalfacilities?: { facility_key?: string; name?: string }[]

      List of gym or fitness facilities.

    • Optionalguests?: {
          email_address?: string;
          guest_key?: string;
          name?: string;
          phone_number?: string;
      }[]

      List of guests.

    • Optionallistings?: { listing_key?: string; name?: string }[]

      List of property listings.

    • Optionallow_battery_alert_threshold?: number | null

      Battery level, from 0 to 1, at or below which device.low_battery events fire for this customer's devices. Overrides the workspace and device defaults. Pass null to remove the customer's override.

    • Optionalproperties?: { name?: string; property_key?: string }[]

      List of short-term rental properties.

    • Optionalproperty_listings?: {
          custom_metadata?: Record<string, string | boolean>;
          name?: string;
          property_listing_key?: string;
      }[]

      List of property listings.

    • Optionalreservations?: {
          building_keys?: string[];
          common_area_keys?: string[];
          custom_metadata?: Record<string, string | boolean>;
          ends_at?: string | Date | Temporal.Instant;
          facility_keys?: string[];
          guest_key?: string;
          listing_keys?: string[];
          name?: string;
          preferred_code?: string | null;
          property_keys?: string[];
          reservation_key?: string;
          resident_key?: string;
          room_keys?: string[];
          space_keys?: string[];
          starts_at?: string | Date | Temporal.Instant;
          tenant_key?: string;
          unit_keys?: string[];
          user_identity_key?: string;
          user_key?: string;
      }[]

      List of reservations.

    • Optionalresidents?: {
          email_address?: string;
          name?: string;
          phone_number?: string;
          resident_key?: string;
      }[]

      List of residents.

    • Optionalrooms?: { name?: string; parent_site_key?: string; room_key?: string }[]

      List of hotel or hospitality rooms.

    • Optionalsites?: { name?: string; site_key?: string }[]

      List of general sites or areas.

    • Optionalspaces?: {
          customer_data?: {
              address?: string | null;
              default_checkin_time?: string | null;
              default_checkout_time?: string | null;
              time_zone?: string | null;
          };
          duration_minutes?: number;
          geolocation?: { latitude?: number; longitude?: number };
          name?: string;
          parent_site_key?: string;
          space_key?: string;
      }[]

      List of general spaces or areas.

    • Optionalstaff_members?: {
          building_keys?: string[];
          common_area_keys?: string[];
          email_address?: string;
          facility_keys?: string[];
          listing_keys?: string[];
          name?: string;
          phone_number?: string;
          property_keys?: string[];
          property_listing_keys?: string[];
          room_keys?: string[];
          site_keys?: string[];
          space_keys?: string[];
          staff_member_key?: string;
          unit_keys?: string[];
      }[]

      List of staff members.

    • Optionaltenants?: {
          email_address?: string;
          name?: string;
          phone_number?: string;
          tenant_key?: string;
      }[]

      List of tenants.

    • Optionalunits?: { name?: string; parent_site_key?: string; unit_key?: string }[]

      List of multi-family residential units.

    • Optionaluser_identities?: {
          email_address?: string;
          name?: string;
          phone_number?: string;
          user_identity_key?: string;
      }[]

      List of user identities.

    • Optionalusers?: {
          email_address?: string;
          name?: string;
          phone_number?: string;
          user_key?: string;
      }[]

      List of users.

    customer_resources_filters?: { field?: string; operation?: "="; value?: string }[]

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

    Type Declaration

    • Optionalfield?: string

      The custom_metadata field name to filter on.

    • Optionaloperation?: "="

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

    • Optionalvalue?: string

      The value to compare against.

    customization_profile_id?: string

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

    deep_link?: {
        resource_id?: string;
        resource_key?: string;
        resource_type?: "reservation" | "space" | "device" | "acs_entrance";
    }

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

    exclude_locale_picker?: boolean

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

    features?: {
        configure?: {
            allow_access_automation_rule_customization?: boolean;
            allow_climate_automation_rule_customization?: boolean;
            allow_instant_key_customization?: boolean;
            allow_notification_customization?: boolean;
            allow_sound_automation_rule_customization?: boolean;
            exclude?: boolean;
        };
        connect?: {
            accepted_providers?: string[];
            exclude?: boolean;
            excluded_providers?: string[];
        };
        manage?: {
            device_management_confirmation?: {
                body?: string;
                cancel_button_label?: string;
                confirm_button_label?: string;
                title?: string;
            };
            events?: { allowed_events?: string[]; default_events?: string[] };
            exclude?: boolean;
            exclude_device_management?: boolean;
            exclude_reservation_management?: boolean;
            exclude_reservation_technical_details?: boolean;
            exclude_staff_management?: boolean;
        };
        manage_devices?: { exclude?: boolean };
        organize?: { exclude?: boolean };
    }

    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.

    Type Declaration

    • Optionalconfigure?: {
          allow_access_automation_rule_customization?: boolean;
          allow_climate_automation_rule_customization?: boolean;
          allow_instant_key_customization?: boolean;
          allow_notification_customization?: boolean;
          allow_sound_automation_rule_customization?: boolean;
          exclude?: boolean;
      }

      Configuration for the configure feature.

      • Optionalallow_access_automation_rule_customization?: boolean

        Indicates whether the customer can customize the access automation rules for their properties.

      • Optionalallow_climate_automation_rule_customization?: boolean

        Indicates whether the customer can customize the climate automation rules for their properties.

      • Optionalallow_instant_key_customization?: boolean

        Indicates whether the customer can customize the Instant Key profile for their properties.

      • Optionalallow_notification_customization?: boolean

        Indicates whether the customer can customize their notification settings, such as the low-battery alert threshold.

      • Optionalallow_sound_automation_rule_customization?: boolean

        Indicates whether the customer can customize the sound automation rules for their properties.

      • Optionalexclude?: boolean

        Whether to exclude this feature from the portal.

    • Optionalconnect?: {
          accepted_providers?: string[];
          exclude?: boolean;
          excluded_providers?: string[];
      }

      Configuration for the connect accounts feature.

      • Optionalaccepted_providers?: string[]

        List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account.

      • Optionalexclude?: boolean

        Whether to exclude this feature from the portal.

      • Optionalexcluded_providers?: string[]

        List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account.

    • Optionalmanage?: {
          device_management_confirmation?: {
              body?: string;
              cancel_button_label?: string;
              confirm_button_label?: string;
              title?: string;
          };
          events?: { allowed_events?: string[]; default_events?: string[] };
          exclude?: boolean;
          exclude_device_management?: boolean;
          exclude_reservation_management?: boolean;
          exclude_reservation_technical_details?: boolean;
          exclude_staff_management?: boolean;
      }

      Configuration for the manage feature.

      • Optionaldevice_management_confirmation?: {
            body?: string;
            cancel_button_label?: string;
            confirm_button_label?: string;
            title?: string;
        }

        Custom copy for the confirmation modal shown before unmanaged devices are added to a space and begin being managed (and billed). Only takes effect when the MANAGE_DEVICES_CONFIRMATION_MODAL feature flag is enabled for the workspace. Any omitted string falls back to a localized default.

        • Optionalbody?: string

          Custom body text for the confirmation modal. May include the {count} token, which is replaced with the number of devices that will begin being managed.

        • Optionalcancel_button_label?: string

          Custom label for the cancel button.

        • Optionalconfirm_button_label?: string

          Custom label for the confirm button.

        • Optionaltitle?: string

          Custom title for the confirmation modal.

      • Optionalevents?: { allowed_events?: string[]; default_events?: string[] }

        Configuration for event type filtering in the manage feature.

        • Optionalallowed_events?: string[]

          List of event types to show in the events filter. When set, only these event types will be available. Leave empty to show all events.

        • Optionaldefault_events?: string[]

          List of event types that are pre-selected in the events filter when the user first loads the events tab.

      • Optionalexclude?: boolean

        Whether to exclude this feature from the portal.

      • Optionalexclude_device_management?: boolean

        Indicates whether to prevent the customer from converting their devices between managed and unmanaged. Managed devices are billed.

      • Optionalexclude_reservation_management?: boolean

        Indicates whether the customer can manage reservations for their properties.

      • Optionalexclude_reservation_technical_details?: boolean

        Indicates whether to exclude technical details from reservation views.

      • Optionalexclude_staff_management?: boolean

        Indicates whether the customer can manage staff for their properties.

    • Optionalmanage_devices?: { exclude?: boolean }
      • Optionalexclude?: boolean

        Whether to exclude this feature from the portal.

    • Optionalorganize?: { exclude?: boolean }

      Configuration for the organize feature.

      • Optionalexclude?: boolean

        Whether to exclude this feature from the portal.

    is_embedded?: boolean

    Whether the portal is embedded in another application.

    Optionallanding_page

    landing_page?: {
        manage?: {
            access_grant_key?: string;
            booking_key?: string;
            building_key?: string;
            common_area_key?: string;
            facility_key?: string;
            listing_key?: string;
            property_key?: string;
            property_listing_key?: string;
            reservation_key?: string;
            room_key?: string;
            site_key?: string;
            space_key?: string;
            unit_key?: string;
        };
    }

    Configuration for the landing page when the portal loads.

    locale?:
        | "en-US"
        | "pt-PT"
        | "fr-FR"
        | "it-IT"
        | "es-ES"
        | "de-DE"
        | "nl-NL"
        | "el-GR"
        | "pl-PL"
        | "ru-RU"

    The locale to use for the portal.

    navigation_mode?: "full" | "restricted"

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

    read_only?: boolean

    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.

    Settings
    Member Visibility

    On This Page
    Properties