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

    Type Alias AccessCodesCreateParameters

    type AccessCodesCreateParameters = {
        allow_external_modification?: boolean;
        attempt_for_offline_device?: boolean;
        code?: string;
        common_code_key?: string;
        device_id: string;
        ends_at?: string;
        is_external_modification_allowed?: boolean;
        is_offline_access_code?: boolean;
        is_one_time_use?: boolean;
        max_time_rounding?: "1hour" | "1day" | "1h" | "1d";
        name?: string;
        prefer_native_scheduling?: boolean;
        preferred_code_length?: number;
        starts_at?: string;
        use_backup_access_code_pool?: boolean;
        use_offline_access_code?: boolean;
    }
    Index
    allow_external_modification? attempt_for_offline_device? code? common_code_key? device_id ends_at? is_external_modification_allowed? is_offline_access_code? is_one_time_use? max_time_rounding? name? prefer_native_scheduling? preferred_code_length? starts_at? use_backup_access_code_pool? use_offline_access_code?
    allow_external_modification?: boolean

    Indicates whether external modification of the code is allowed. Default: false.

    attempt_for_offline_device?: boolean
    code?: string

    Code to be used for access.

    common_code_key?: string

    Key to identify access codes that should have the same code. Any two access codes with the same common_code_key are guaranteed to have the same code. See also Creating and Updating Multiple Linked Access Codes.

    device_id: string

    ID of the device for which you want to create the new access code.

    ends_at?: string

    Date and time at which the validity of the new access code ends, in ISO 8601 format. Must be a time in the future and after starts_at.

    is_external_modification_allowed?: boolean

    Indicates whether external modification of the code is allowed. Default: false.

    is_offline_access_code?: boolean

    Indicates whether the access code is an offline access code.

    is_one_time_use?: boolean

    Indicates whether the offline access code is a single-use access code.

    max_time_rounding?: "1hour" | "1day" | "1h" | "1d"

    Maximum rounding adjustment. To create a daily-bound offline access code for devices that support this feature, set this parameter to 1d.

    name?: string

    Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.

    Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as first_name and last_name.

    To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.

    To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called appearance. This is an object with a name property and, optionally, first_name and last_name properties (for providers that break down a name into components).

    prefer_native_scheduling?: boolean

    Indicates whether native scheduling should be used for time-bound codes when supported by the provider. Default: true.

    preferred_code_length?: number

    Preferred code length. Only applicable if you do not specify a code. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length.

    starts_at?: string

    Date and time at which the validity of the new access code starts, in ISO 8601 format.

    use_backup_access_code_pool?: boolean

    Indicates whether to use a backup access code pool provided by Seam. If true, you can use /access_codes/pull_backup_access_code.

    use_offline_access_code?: boolean

    Use is_offline_access_code instead.

    Settings
    Member Visibility

    On This Page
    Properties