Sign in

v2

latestOpenAPI 3.1.02026-08-01244220427.0 KB
Devices

Update Device

Update device information.

Parameters:

  • device_id (PydanticObjectId): Device ID
  • request (DeviceUpdateRequest): Update data
  • current_user (User): Authenticated user making the request

Returns:

  • DeviceInfo: Updated device details

Raises:

  • 404: If device not found or not owned by the current user
patch/v2/devices/{device_id}

Path parameters

device_idstring required
Example:5eb7cf5a86d9755df3a6c593

Headers

authorizationstring nullable

Request body

deviceNamestring nullable

New device name

locationNamestring nullable

New location name

locationAddressstring nullable

New location address

status'active' | 'inactive' | 'blocked' | 'pending_activation'

Device status enumeration.

Response

Successful Response

deviceIdstring required

Device ID

deviceSidstring required

Device SID

deviceType'tablet_kiosk' | 'tablet' | 'kiosk' required

Device type enumeration for tablet/kiosk devices.

deviceNamestring required

Device name

status'active' | 'inactive' | 'blocked' | 'pending_activation' required

Device status enumeration.

programIdstring required

Loyalty program ID

lastSeenAtstring date-time nullable

Last time the device was active

activatedAtstring date-time nullable

When the device was activated

locationNamestring nullable

Physical location of device