Skip to main content
POST

Overview

Assigns a device to one or more customers. Creates the mapping for telemetry correlation. Features:
  • Auto-creates customers if they don’t exist
  • Supports multi-owner assignments (shared/family devices)
  • Optional auto-create for devices (requires deviceType)

Authentication

string
required
Your organization’s API key

Request Body

string
required
The unique identifier for the device (e.g., serial number, MAC address)
array
required
Array of customer email addresses to assign the device to. Must contain at least one valid email.
boolean
default:false
If true, creates the device automatically if it doesn’t exist in the system. Defaults to false.
string
Required when autoCreateDevice is true. Specifies the device type (e.g., “Thermostat”, “Sensor”, “Gateway”). This field is mandatory for creating new devices.

Response

boolean
Indicates if the operation was successful
string
Description of the operation result
string
The unique device ID in the Telemetron system
boolean
Indicates whether the device was created during this operation. Always present in the response.
array
Array of customer objects that were assigned the device

Examples

Single Customer Assignment

Bulk Assignment (Multiple Customers)

Auto-Create Device

Response

Status Codes

Implementation Notes

  • Multi-owner support: Assign a single device to multiple customers for shared/family accounts
  • Auto-create customers: Non-existent customers are automatically created using email prefix as name
  • Auto-create devices: Set autoCreateDevice: true and provide deviceType to create devices on-the-fly
  • Email handling: Emails are trimmed, lowercased, and validated. Invalid emails are skipped
  • Idempotent: Re-assigning an already-assigned device won’t create duplicates
Required: When autoCreateDevice is true, you must provide deviceType or the request will fail with a 400 error.