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

    Type Alias DevicesUpdateParameters

    type DevicesUpdateParameters = {
        backup_access_code_pool_enabled?: boolean;
        custom_metadata?: Record<string, string | boolean>;
        device_id: string;
        is_managed?: boolean;
        name?: string | null;
        properties?: { name?: string | null };
    }
    Index
    backup_access_code_pool_enabled? custom_metadata? device_id is_managed? name? properties?
    backup_access_code_pool_enabled?: boolean

    Indicates whether the device's backup access code pool is enabled. Set to false to disable the pool: Seam stops refilling it and removes any backup codes that have not yet been pulled into active use.

    custom_metadata?: Record<string, string | boolean>

    Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs, with key names up to 40 characters long that cannot contain a period (.). Adding custom metadata to a device enables you to store custom information, like customer details or internal IDs from your application. Then, you can filter devices by the desired metadata. Set a key to null or to an empty string to remove that key from the custom metadata.

    device_id: string

    ID of the device that you want to update.

    is_managed?: boolean

    Indicates whether the device is managed. To unmanage a device, set is_managed to false.

    name?: string | null

    Name for the device.

    properties?: { name?: string | null }

    Type Declaration

    • Optionalname?: string | null

      Name for the device.

    Settings
    Member Visibility

    On This Page
    Properties