Track Device Variables

6min
Stores or updates devices-specific variables
POST
Request
Header Parameters
Date
required
String
eq. Thu, 17 Nov 2022 20:51:35 GMT
Authorization
required
String
See signing of the License API calls article.
Body Parameters
hardware_id
required
String
Unique hardware ID generated for some device
product
required
String
Product short code
variables
required
Object
Variables are sent as a JSON object, where parameter is the variable name and value is the value of the variable
license_key
optional
String
Required if product is key_based. Attach the license key (eq. 1111-2222-3333-4444)
username
optional
String
Required if product is user based. Attach the assigned license user email (eq. [email protected])
license_id
optional
Number
Ensures that the action affects only the license with the specified ID. This is useful if e.g. you have multiple licenses for the same product assigned to the same user. For obtaining a list of licenses assigned to a user, see "User Licenses"
Curl
Node.js
JS
Python
Ruby
import requests

url = "/api/v4/track_device_variables"

payload = "{\"hardware_id\":\"String\",\"product\":\"string\",\"variables\":\"Object\",\"license_key\":\"string\",\"username\":\"string\"}"
headers = {
   'Accept': 'application/json',
   'Date': 'string',
   'Authorization': 'string'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

import requests

url = "/api/v4/track_device_variables"

payload = "{\"hardware_id\":\"String\",\"product\":\"string\",\"variables\":\"Object\",\"license_key\":\"string\",\"username\":\"string\"}"
headers = {
   'Accept': 'application/json',
   'Date': 'string',
   'Authorization': 'string'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)
Responses
200
400
[
    {
        "variable": "first_variable",
        "value": "cooling",
        "device_id": 1698663677416479,
        "created_at": 1698667364802
    }
]
[
    {
        "variable": "first_variable",
        "value": "cooling",
        "device_id": 1698663677416479,
        "created_at": 1698667364802
    }
]
﻿
Variables are sent as a JSON object, where parameter is the variable name and value is the value of the variable.
Eq.
"variables": {
    "first_variable": "something",
    "second_variable": "something else"
}
If any of the variables already exist on specific device, their value will be overwritten!
Device variables can also be set during activation by providing a variables parameter in the activation payload, with the same syntax as described on this page. For more details see: License Activation﻿, License Activation Offline﻿ 
List of exceptions
unknown_product (400): Provided product was not found
license_not_found (400): License with the provided license user not found
license_not_active (400): The license is not active
license_not_enabled (400): The license is not enabled
device_not_found (400): An active device matching the hardware_id not found
blacklisted (400): This device is blacklisted
invalid json?
Updated 25 Sep 2024
Did this page help you?
Get Device Variables
Changing Password