Type Alias CustomersPushDataParameters

type CustomersPushDataParameters = {
    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 }[];
    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;
    }[];
}

Properties

`Optional`access_grants

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;
}[]

List of access grants.

Type Declaration

Optionalaccess_grant_key?: string

Your unique identifier for the access grant.
Optionalbuilding_keys?: string[]

Building keys associated with the access grant.
Optionalcommon_area_keys?: string[]

Common area keys associated with the access grant.
Optionalends_at?: string | Date | Temporal.Instant

Ending date and time for the access grant.
Optionalfacility_keys?: string[]

Facility keys associated with the access grant.
Optionalguest_key?: string

Guest key associated with the access grant.
Optionallisting_keys?: string[]

Listing keys associated with the access grant.
Optionalname?: string

Your name for this access grant resource.
Optionalpreferred_code?: string | null

Preferred PIN code to use when creating access for this reservation. Set to null to remove a previously set preferred code, so that access falls back to an automatically generated code. Omitting this field keeps any previously set preferred code.
Optionalproperty_keys?: string[]

Property keys associated with the access grant.
Optionalresident_key?: string

Resident key associated with the access grant.
Optionalroom_keys?: string[]

Room keys associated with the access grant.
Optionalspace_keys?: string[]

Space keys associated with the access grant.
Optionalstarts_at?: string | Date | Temporal.Instant

Starting date and time for the access grant.
Optionaltenant_key?: string

Tenant key associated with the access grant.
Optionalunit_keys?: string[]

Unit keys associated with the access grant.
Optionaluser_identity_key?: string

User identity key associated with the access grant.
Optionaluser_key?: string

User key associated with the access grant.

`Optional`bookings

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;
}[]

List of bookings.

Type Declaration

Optionalbooking_key?: string

Your unique identifier for the booking.
Optionalbuilding_keys?: string[]

Building keys associated with the access grant.
Optionalcommon_area_keys?: string[]

Common area keys associated with the access grant.
Optionalends_at?: string | Date | Temporal.Instant

Ending date and time for the access grant.
Optionalfacility_keys?: string[]

Facility keys associated with the access grant.
Optionalguest_key?: string

Guest key associated with the access grant.
Optionallisting_keys?: string[]

Listing keys associated with the access grant.
Optionalname?: string

Your name for this access grant resource.
Optionalpreferred_code?: string | null

Preferred PIN code to use when creating access for this reservation. Set to null to remove a previously set preferred code, so that access falls back to an automatically generated code. Omitting this field keeps any previously set preferred code.
Optionalproperty_keys?: string[]

Property keys associated with the access grant.
Optionalresident_key?: string

Resident key associated with the access grant.
Optionalroom_keys?: string[]

Room keys associated with the access grant.
Optionalspace_keys?: string[]

Space keys associated with the access grant.
Optionalstarts_at?: string | Date | Temporal.Instant

Starting date and time for the access grant.
Optionaltenant_key?: string

Tenant key associated with the access grant.
Optionalunit_keys?: string[]

Unit keys associated with the access grant.
Optionaluser_identity_key?: string

User identity key associated with the access grant.
Optionaluser_key?: string

User key associated with the access grant.

`Optional`buildings

buildings?: { building_key?: string; name?: string }[]

List of buildings.

Type Declaration

Optionalbuilding_key?: string

Your unique identifier for the building.
Optionalname?: string

Your display name for this location resource.

`Optional`common_areas

common_areas?: {
    common_area_key?: string;
    name?: string;
    parent_site_key?: string;
}[]

List of shared common areas.

Type Declaration

Optionalcommon_area_key?: string

Your unique identifier for the common area.
Optionalname?: string

Your display name for this location resource.
Optionalparent_site_key?: string

Your unique identifier for the site.

customer_key

customer_key: string

Your unique identifier for the customer.

`Optional`customization_profile_id

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

`Optional`facilities

facilities?: { facility_key?: string; name?: string }[]

List of gym or fitness facilities.

Type Declaration

Optionalfacility_key?: string

Your unique identifier for the facility.
Optionalname?: string

Your display name for this location resource.

`Optional`guests

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

List of guests.

Type Declaration

Optionalemail_address?: string

Email address associated with the user identity.
Optionalguest_key?: string

Your unique identifier for the guest.
Optionalname?: string

Your display name for this user identity resource.
Optionalphone_number?: string

Phone number associated with the user identity.

`Optional`listings

listings?: { listing_key?: string; name?: string }[]

List of property listings.

Type Declaration

Optionallisting_key?: string

Your unique identifier for the listing.
Optionalname?: string

Your display name for this location resource.

`Optional`properties

properties?: { name?: string; property_key?: string }[]

List of short-term rental properties.

Type Declaration

Optionalname?: string

Your display name for this location resource.
Optionalproperty_key?: string

Your unique identifier for the property.

`Optional`property_listings

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

List of property listings.

Type Declaration

Optionalcustom_metadata?: Record<string, string | boolean>

Set key:value pairs. Accepts string or Boolean values. Adding custom metadata to a property listing enables you to store custom information, like customer details or internal IDs from your application. Set a key to null or to an empty string to remove that key from the custom metadata.
Optionalname?: string

Your display name for this location resource.
Optionalproperty_listing_key?: string

Your unique identifier for the property listing.

`Optional`reservations

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;
}[]

List of reservations.

Type Declaration

Optionalbuilding_keys?: string[]

Building keys associated with the access grant.
Optionalcommon_area_keys?: string[]

Common area keys associated with the access grant.
Optionalcustom_metadata?: Record<string, string | boolean>

Set key:value pairs for filtering reservations by custom criteria. Set a key to null or to an empty string to remove that key from the custom metadata.
Optionalends_at?: string | Date | Temporal.Instant

Ending date and time for the access grant.
Optionalfacility_keys?: string[]

Facility keys associated with the access grant.
Optionalguest_key?: string

Guest key associated with the access grant.
Optionallisting_keys?: string[]

Listing keys associated with the access grant.
Optionalname?: string

Your name for this access grant resource.
Optionalpreferred_code?: string | null

Preferred PIN code to use when creating access for this reservation. Set to null to remove a previously set preferred code, so that access falls back to an automatically generated code. Omitting this field keeps any previously set preferred code.
Optionalproperty_keys?: string[]

Property keys associated with the access grant.
Optionalreservation_key?: string

Your unique identifier for the reservation.
Optionalresident_key?: string

Resident key associated with the access grant.
Optionalroom_keys?: string[]

Room keys associated with the access grant.
Optionalspace_keys?: string[]

Space keys associated with the access grant.
Optionalstarts_at?: string | Date | Temporal.Instant

Starting date and time for the access grant.
Optionaltenant_key?: string

Tenant key associated with the access grant.
Optionalunit_keys?: string[]

Unit keys associated with the access grant.
Optionaluser_identity_key?: string

User identity key associated with the access grant.
Optionaluser_key?: string

User key associated with the access grant.

`Optional`residents

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

List of residents.

Type Declaration

Optionalemail_address?: string

Email address associated with the user identity.
Optionalname?: string

Your display name for this user identity resource.
Optionalphone_number?: string

Phone number associated with the user identity.
Optionalresident_key?: string

Your unique identifier for the resident.

`Optional`rooms

rooms?: { name?: string; parent_site_key?: string; room_key?: string }[]

List of hotel or hospitality rooms.

Type Declaration

Optionalname?: string

Your display name for this location resource.
Optionalparent_site_key?: string

Your unique identifier for the site.
Optionalroom_key?: string

Your unique identifier for the room.

`Optional`sites

sites?: { name?: string; site_key?: string }[]

List of general sites or areas.

Type Declaration

Optionalname?: string

Your display name for this location resource.
Optionalsite_key?: string

Your unique identifier for the site.

`Optional`spaces

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;
}[]

List of general spaces or areas.

Type Declaration

Optionalcustomer_data?: {
    address?: string | null;
    default_checkin_time?: string | null;
    default_checkout_time?: string | null;
    time_zone?: string | null;
}

Reservation/stay-related defaults for the space (time zone, default check-in/out times, address).
- Optionaladdress?: string | null
  
  Postal address for the space.
- Optionaldefault_checkin_time?: string | null
  
  Default check-in time for reservations at the space, as HH:mm or HH:mm:ss.
- Optionaldefault_checkout_time?: string | null
  
  Default check-out time for reservations at the space, as HH:mm or HH:mm:ss.
- Optionaltime_zone?: string | null
  
  IANA time zone for the space, e.g. America/Los_Angeles.
Optionalduration_minutes?: number

Default duration of this space in minutes, when the space represents a fixed-length bookable slot (e.g. an appointment type). Used to interpret reservations booked against this space.
Optionalgeolocation?: { latitude?: number; longitude?: number }

Geographic coordinates (latitude and longitude) of the space.
- Optionallatitude?: number
  
  Latitude of the space, in decimal degrees.
- Optionallongitude?: number
  
  Longitude of the space, in decimal degrees.
Optionalname?: string

Your display name for this location resource.
Optionalparent_site_key?: string

Your unique identifier for the site.
Optionalspace_key?: string

Your unique identifier for the space.

`Optional`staff_members

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[];
}[]

List of staff members.

Type Declaration

Optionalbuilding_keys?: string[]

List of unique identifiers for the buildings the staff member is associated with.
Optionalcommon_area_keys?: string[]

List of unique identifiers for the common areas the staff member is associated with.
Optionalemail_address?: string

Email address associated with the user identity.
Optionalfacility_keys?: string[]

List of unique identifiers for the facilities the staff member is associated with.
Optionallisting_keys?: string[]

List of unique identifiers for the listings the staff member is associated with.
Optionalname?: string

Your display name for this user identity resource.
Optionalphone_number?: string

Phone number associated with the user identity.
Optionalproperty_keys?: string[]

List of unique identifiers for the properties the staff member is associated with.
Optionalproperty_listing_keys?: string[]

List of unique identifiers for the property listings the staff member is associated with.
Optionalroom_keys?: string[]

List of unique identifiers for the rooms the staff member is associated with.
Optionalsite_keys?: string[]

List of unique identifiers for the sites the staff member is associated with.
Optionalspace_keys?: string[]

List of unique identifiers for the spaces the staff member is associated with.
Optionalstaff_member_key?: string

Your unique identifier for the staff.
Optionalunit_keys?: string[]

List of unique identifiers for the units the staff member is associated with.

`Optional`tenants

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

List of tenants.

Type Declaration

Optionalemail_address?: string

Email address associated with the user identity.
Optionalname?: string

Your display name for this user identity resource.
Optionalphone_number?: string

Phone number associated with the user identity.
Optionaltenant_key?: string

Your unique identifier for the tenant.

`Optional`units

units?: { name?: string; parent_site_key?: string; unit_key?: string }[]

List of multi-family residential units.

Type Declaration

Optionalname?: string

Your display name for this location resource.
Optionalparent_site_key?: string

Your unique identifier for the site.
Optionalunit_key?: string

Your unique identifier for the unit.

`Optional`user_identities

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

List of user identities.

Type Declaration

Optionalemail_address?: string

Email address associated with the user identity.
Optionalname?: string

Your display name for this user identity resource.
Optionalphone_number?: string

Phone number associated with the user identity.
Optionaluser_identity_key?: string

Your unique identifier for the user identity.

`Optional`users

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

List of users.

Type Declaration

Optionalemail_address?: string

Email address associated with the user identity.
Optionalname?: string

Your display name for this user identity resource.
Optionalphone_number?: string

Phone number associated with the user identity.
Optionaluser_key?: string

Your unique identifier for the user.

Type Alias CustomersPushDataParameters

Index

Properties

Properties

Optionalaccess_grants

Type Declaration

Optionalaccess_grant_key?: string

Optionalbuilding_keys?: string[]

Optionalcommon_area_keys?: string[]

Optionalends_at?: string | Date | Temporal.Instant

Optionalfacility_keys?: string[]

Optionalguest_key?: string

Optionallisting_keys?: string[]

Optionalname?: string

Optionalpreferred_code?: string | null

Optionalproperty_keys?: string[]

Optionalresident_key?: string

Optionalroom_keys?: string[]

Optionalspace_keys?: string[]

Optionalstarts_at?: string | Date | Temporal.Instant

Optionaltenant_key?: string

Optionalunit_keys?: string[]

Optionaluser_identity_key?: string

Optionaluser_key?: string

Optionalbookings

Type Declaration

Optionalbooking_key?: string

Optionalbuilding_keys?: string[]

Optionalcommon_area_keys?: string[]

Optionalends_at?: string | Date | Temporal.Instant

Optionalfacility_keys?: string[]

Optionalguest_key?: string

Optionallisting_keys?: string[]

Optionalname?: string

Optionalpreferred_code?: string | null

Optionalproperty_keys?: string[]

Optionalresident_key?: string

Optionalroom_keys?: string[]

Optionalspace_keys?: string[]

Optionalstarts_at?: string | Date | Temporal.Instant

Optionaltenant_key?: string

Optionalunit_keys?: string[]

Optionaluser_identity_key?: string

Optionaluser_key?: string

Optionalbuildings

Type Declaration

Optionalbuilding_key?: string

Optionalname?: string

Optionalcommon_areas

Type Declaration

Optionalcommon_area_key?: string

Optionalname?: string

Optionalparent_site_key?: string

customer_key

Optionalcustomization_profile_id

Optionalfacilities

Type Declaration

Optionalfacility_key?: string

Optionalname?: string

Optionalguests

Type Declaration

Optionalemail_address?: string

Optionalguest_key?: string

Optionalname?: string

Optionalphone_number?: string

Optionallistings

Type Declaration

Optionallisting_key?: string

Optionalname?: string

Optionalproperties

Type Declaration

Optionalname?: string

Optionalproperty_key?: string

Optionalproperty_listings

Type Declaration

Optionalcustom_metadata?: Record<string, string | boolean>

Optionalname?: string

Optionalproperty_listing_key?: string

Optionalreservations

Type Declaration

`Optional`access_grants

`Optional`access_grant_key?: string

`Optional`building_keys?: string[]

`Optional`common_area_keys?: string[]

`Optional`ends_at?: string | Date | Temporal.Instant

`Optional`facility_keys?: string[]

`Optional`guest_key?: string

`Optional`listing_keys?: string[]

`Optional`name?: string

`Optional`preferred_code?: string | null

`Optional`property_keys?: string[]

`Optional`resident_key?: string

`Optional`room_keys?: string[]

`Optional`space_keys?: string[]

`Optional`starts_at?: string | Date | Temporal.Instant

`Optional`tenant_key?: string

`Optional`unit_keys?: string[]

`Optional`user_identity_key?: string

`Optional`user_key?: string

`Optional`bookings

`Optional`booking_key?: string

`Optional`building_keys?: string[]

`Optional`common_area_keys?: string[]

`Optional`ends_at?: string | Date | Temporal.Instant

`Optional`facility_keys?: string[]

`Optional`guest_key?: string

`Optional`listing_keys?: string[]

`Optional`name?: string

`Optional`preferred_code?: string | null

`Optional`property_keys?: string[]

`Optional`resident_key?: string

`Optional`room_keys?: string[]

`Optional`space_keys?: string[]

`Optional`starts_at?: string | Date | Temporal.Instant

`Optional`tenant_key?: string

`Optional`unit_keys?: string[]

`Optional`user_identity_key?: string

`Optional`user_key?: string

`Optional`buildings

`Optional`building_key?: string

`Optional`name?: string

`Optional`common_areas

`Optional`common_area_key?: string

`Optional`name?: string

`Optional`parent_site_key?: string

`Optional`customization_profile_id

`Optional`facilities

`Optional`facility_key?: string

`Optional`name?: string

`Optional`guests

`Optional`email_address?: string

`Optional`guest_key?: string

`Optional`name?: string

`Optional`phone_number?: string

`Optional`listings

`Optional`listing_key?: string

`Optional`name?: string

`Optional`properties

`Optional`name?: string

`Optional`property_key?: string

`Optional`property_listings

`Optional`custom_metadata?: Record<string, string | boolean>

`Optional`name?: string

`Optional`property_listing_key?: string

`Optional`reservations

`Optional`building_keys?: string[]

`Optional`common_area_keys?: string[]

`Optional`custom_metadata?: Record<string, string | boolean>

`Optional`ends_at?: string | Date | Temporal.Instant

`Optional`facility_keys?: string[]

`Optional`guest_key?: string

`Optional`listing_keys?: string[]

`Optional`name?: string

`Optional`preferred_code?: string | null

`Optional`property_keys?: string[]

`Optional`reservation_key?: string

`Optional`resident_key?: string

`Optional`room_keys?: string[]

`Optional`space_keys?: string[]

`Optional`starts_at?: string | Date | Temporal.Instant