Commission a device

POST

/devices/{serialId}/commission

curl --request POST \
  --url https://app.buildtrace.eu/api/devices/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/commission \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "deviceIdentifier": "example" }'

Required scope: field:write.

Authorizations

• bearerAuth

Parameters

Path Parameters

serialId

required

string format: uuid

Request Body^required

Media typeapplication/json

object

deviceIdentifier

required

string

Example ^generated

{
  "deviceIdentifier": "example"
}

Responses

201

Created

Media typeapplication/json

object

device

required

object

id

required

string format: uuid

serialId

required

string format: uuid

fleetId

string format: uuid

serialNumber

The unit’s serial number (on listed and fetched devices).

string

deviceIdentifier

required

string

deploymentStatus

required

string

lastSeenAt

When the device last checked in; absent if it never has.

string format: date-time

connectionStatus

required

string

firmwareCompliant

required

boolean

deploymentLocation

string

customerName

string

token

required

string

Example ^generated

{
  "device": {
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "serialId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "fleetId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "serialNumber": "example",
    "deviceIdentifier": "example",
    "deploymentStatus": "example",
    "lastSeenAt": "2026-04-15T12:00:00Z",
    "connectionStatus": "example",
    "firmwareCompliant": true,
    "deploymentLocation": "example",
    "customerName": "example"
  },
  "token": "example"
}

400

Bad request

Media typeapplication/json

object

error

required

string

Example ^generated

{
  "error": "example"
}

401

Unauthorized

404

Not found

409

Conflict (unit already commissioned)

Media typeapplication/json

object

error

required

string

Example ^generated

{
  "error": "example"
}