API ReferenceTrackingSessions

Update

Updates mutable non-geofence session fields. Use dedicated geofence routes for geofence changes. | auth: api_key | authz: min_org_role=operator | (SessionClientUpdate2) -> (bool)

Authentication

AuthorizationBearer

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

Query parameters

session_idstringRequired

Request

This endpoint expects an object.
commentsstring or nullOptional<=524288 characters
comments__set_to_NonebooleanOptionalDefaults to false
off_chrt_reference_idstring or nullOptionalformat: "^[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_reference_id__set_to_NonebooleanOptionalDefaults to false
publicboolean or nullOptional
termination_scheduled_for_timestampdatetime or nullOptional
termination_scheduled_for_timestamp__set_to_NonebooleanOptionalDefaults to false

Response

Successful Response

Errors

422
Sessions Update V1request Unprocessable Entity Error