Update

POST

/tracking/devices/update/v1

Updates a device’s type, comments, and/or off_chrt_reference_id. Use __set_to_None flags to explicitly clear Optional fields. | auth: api_key | (DeviceClientUpdate1) -> (bool)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

device_idstringRequired

Request

This endpoint expects an object.

typeenumOptional

Allowed values:

commentsstringOptional<=524288 characters

off_chrt_reference_idstringOptionalformat: "^[A-Za-z0-9._~\-]{1,64}$"1-64 characters

Must be a URL-safe string of 1-64 characters. Allowed characters: A-Z, a-z, 0-9, ’.’, ’_’, ’~’, ’-’ (RFC 3986 unreserved).

type__set_to_NonebooleanOptionalDefaults to false

comments__set_to_NonebooleanOptionalDefaults to false

off_chrt_reference_id__set_to_NonebooleanOptionalDefaults to false

Response

Successful Response

Errors

422

Devices Update V1request Unprocessable Entity Error

1	import { ChrtClient } from "@chrt-inc/typescript-sdk";
2
3	async function main() {
4	const client = new ChrtClient({
5	token: "YOUR_TOKEN_HERE",
6	});
7	await client.tracking.devices.updateV1({
8	device_id: "device_id",
9	});
10	}
11	main();