Sign in

v15

latestOpenAPI 3.1.02026-07-1295183803.5 KB
Tracking_Trip

Update a trip

Updates the data of a specified trip with the provided data.

put/skynet/trip/{id}

Path parameters

idstring required

Specify the ID of the trip to be updated. Please note that a trip which has ended can not be updated.

Query parameters

keystring 32 character alphanumeric string required
Example:key=API_KEY

A key is a unique identifier that is required to authenticate a request to the API.

Request body

asset_idstring required

Use this param to update the ID of the asset which made this trip. Please be cautious when using this field as providing an ID other than what was provided at the time of starting the trip, will link a new asset to the trip and un-link the original asset, even if the trip is still active.

namestring

Use this property to update the name of the trip.

descriptionstring

Use this parameter to update the custom description of the trip.

meta_dataobject

Use this JSON object to update additional details about the trip. This property is used to add any custom information / context about the trip.

Please note that updating the meta_data field will overwrite the previously added information.

attributesobject

Use this field to update the attributes of the trip. Please note that when updating the attributes field, previously added information will be overwritten.

Example request

{
  "name": "\"name\": \"Employee Pickup\"",
  "stops": [
    {
      "name": "\"name\":\"Head Office\""
    }
  ]
}

Response

Trip updated

messagestring

Displays the error message in case of a failed request. If the request is successful, this field is not present in the response.

statusstring

A string indicating the state of the response. On successful responses, the value will be Ok. Indicative error messages are returned for different errors. See the API Error Codes section below for more information.