API ReferenceTrackingSessions

Create

Creates a tracking session with ordered geofences or an organization template and links its device. | auth: api_key | authz: min_org_role=operator | (SessionsCreateV1Req) -> (PydanticObjectId)

Authentication

AuthorizationBearer

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

Query parameters

device_idstringRequired
no_auto_terminationbooleanOptionalDefaults to false

Request

This endpoint expects an object.
schema_versionintegerRequired
commentsstringOptional<=524288 characters
geofence_template_idstringOptional
geofenceslist of objectsOptional
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).

off_chrt_shipper_org_data_idstringOptional
publicbooleanOptionalDefaults to false
termination_scheduled_for_timestampdatetimeOptional

Response

Successful Response

Errors

422
Sessions Create Session V1request Unprocessable Entity Error