API ReferenceTrackingSessions

Update

Updates a session's mutable metadata (off_chrt_reference_id, comments, public, termination_scheduled_for_timestamp, destination_geofence_location, destination_geofence_radius_miles). Setting or replacing the destination geofence location resets the entered latch so it can fire again; clearing it (destination_geofence_location__set_to_None) also resets the latch. | auth: api_key | (SessionClientUpdate1) -> (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.
commentsstringOptional<=524288 characters
comments__set_to_NonebooleanOptionalDefaults to false
destination_geofence_locationobjectOptional

GeoJSON Feature with typed properties for locations

The geometry field is strongly typed as Geometry (union of all geometry types) but remains optional to match the base Feature class specification. To ensure geometry is always present, validate it at runtime or make it required.

destination_geofence_location__set_to_NonebooleanOptionalDefaults to false
destination_geofence_radius_milesdoubleOptional<=10000
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_reference_id__set_to_NonebooleanOptionalDefaults to false
publicbooleanOptional
termination_scheduled_for_timestampdatetimeOptional
termination_scheduled_for_timestamp__set_to_NonebooleanOptionalDefaults to false

Response

Successful Response

Errors

422
Sessions Update V1request Unprocessable Entity Error