Update device

https://api.kustom.co/ipp/v1/devices/{id}

Updates device properties such as name, metadata, or location assignment.

Parameters

Request body

200

401

404

Example

Parameters1 field

• idstring · uuidrequiredin path

  Device ID

Request body4 fields

• namestringoptional

  Display name of the device.

• metadataobjectoptional

  Custom metadata key-value pairs for the device.

  1 field in metadata

  • keystringoptional

    Any additional property. The key is free-form; the value has this shape.

• location_idstring · uuidoptional

  Location identifier to assign the device to.

200

Response14 fields

Device updated successfully.

• idstringoptional

  Unique device identifier.

• unique_idstringoptionaldeprecated

  Hardware identifier (deprecated, use hardwareId).

• hardware_idstringoptional

  Hardware identifier of the device.

• merchant_idstringoptional

  Merchant identifier.

• location_idstringoptional

  Location identifier where the device is registered.

• namestringoptional

  Display name of the device.

• platformstringoptional

  Device platform.

  • IOS
  • ANDROID
  • TERMINAL
• metadataobjectoptional

  Custom metadata key-value pairs for the device.

  1 field in metadata

  • keystringoptional

    Any additional property. The key is free-form; the value has this shape.

• created_atstring · date-timeoptional

  Timestamp when the device was created.

• open_cash_register_idinteger · int32optional

  ID of the currently open cash register on this device.

• credentialsobjectoptional

  Device credentials (only returned during registration).

  2 fields in credentials

  • bearer_tokenstringoptional

    Bearer token for device authentication.

  • issuedAtstring · date-timeoptional

    Timestamp when the token was issued.

401

Response0 fields

Missing or invalid credentials.

No response body — this status returns headers only.

404

Response0 fields

Device not found.

No response body — this status returns headers only.

PUT https://api.kustom.co/ipp/v1/devices/{id}

RequestBodyResponse200401404

Request body· application/json

{
  "name": "POS Terminal 1",
  "metadata": {
    "store_id": "123",
    "region": "EU"
  },
  "location_id": "550e8400-e29b-41d4-a716-446655440000"
}

8 linesCopy

Response 200· Device updated successfully.

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "unique_id": "ABC123XYZ",
  "hardware_id": "ABC123XYZ",
  "merchant_id": "merchant_12345",
  "location_id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "POS Terminal 1",
  "platform": "IOS",
  "metadata": {
    "store_id": "123",
    "region": "EU"
  },
  "created_at": "2024-01-15T10:30:00Z",
  "open_cash_register_id": 42,
  "credentials": {
    "bearer_token": "eyJhbGciOiJSUzI1NiIsInR5cCI...",
    "issuedAt": "2024-01-15T10:30:00Z"
  }
}

19 linesCopy

Response 401· Missing or invalid credentials.

No response body.

This status returns headers only — there is nothing to parse.

—

Response 404· Device not found.

No response body.

This status returns headers only — there is nothing to parse.

—