Geotab

App · 22 actions

Work with your Geotab fleet: vehicles and where they are, trips, GPS history, engine readings and fault codes, rule violations, zones, drivers' hours and messages to drivers.

Actions

ActionWhat it does
Create zoneCreate a circular zone (geofence) round a point, such as a customer site, for the whole organization or one group.
Delete zoneDelete a zone for good.
Get address at a locationLook up the street address at a latitude and longitude, such as a vehicle's position, and any zones it is in.
Get current userGet the MyGeotab user the connection signs in as: name, email, time zone, groups and security clearance.
Get duty status logsGet hours-of-service duty status logs (driving, on duty, off duty and so on) in a time window, for a driver, a vehicle or everyone.
Get engine readingsGet a vehicle's readings of one measure, such as odometer, engine hours or fuel level, in a time window.
Get fault codesGet engine and device fault codes recorded in a time window, for a vehicle or the fleet, with their state and warning lamps.
Get GPS historyGet a vehicle's recorded positions and speeds (km/h) in a time window, oldest first.
Get rule violationsGet the exception events (rule violations, such as speeding) raised in a time window, for a rule, a vehicle or the fleet.
Get tripsGet the trips driven in a time window, for a vehicle, a driver or the fleet: start, stop, distance (km), speeds (km/h), idling and where each ended.
Get userGet one MyGeotab user or driver with their email, employee number, groups and whether they are a driver.
Get vehicleGet one vehicle with its serial number, plate, VIN, comment and groups.
Get vehicle locationsGet where vehicles are now: position, speed, heading, driver and whether each is driving, for one vehicle, a group or the fleet (Geotab returns up to 50 at a time).
List groupsList the organization's groups (such as regions or departments), each with its parent and the groups under it.
List messagesList text messages sent to or from vehicles in a time window, with when each was sent, delivered and read.
List rulesList the rules that raise exception events, such as speeding, harsh braking or after-hours use.
List usersList MyGeotab users, or only drivers, by name.
List vehiclesList the vehicles (GO devices) in the database, by name or group: name, serial number, plate, VIN and groups.
List zonesList the zones (geofences) active now, such as customer sites and depots, with their outlines.
Send message to vehicleSend a text message to a vehicle's driver, shown in Geotab Drive or on the vehicle's connected display, from the connected user.
Update vehicleChange a vehicle's name, licence plate, plate state or province, VIN or comment.
Update zoneRename a zone or change its comment, keeping its outline and everything else.

Create zone

Create a circular zone (geofence) round a point, such as a customer site, for the whole organization or one group.

Inputs

NamenametextRequired
The zone's name, shown on the map and in reports.
LatitudelatitudenumberRequired
Latitude in decimal degrees, -90 to 90, such as 43.4383.From -90 to 90.
LongitudelongitudenumberRequired
Longitude in decimal degrees, -180 to 180, such as -79.7123.From -180 to 180.
Radius (metres)radius_mnumberRequired
How far the zone reaches from the centre, 10 to 100,000 metres.From 10 to 100000.
Typezone_typetext
What the place is. Defaults to Customer.One of: ZoneTypeCustomerId (Customer), ZoneTypeOfficeId (Office), ZoneTypeHomeId (Home), ZoneTypeVendorServiceCenterId (Vendor service centre), ZoneTypeInHouseServiceCenterId (In-house service centre).
Commentcommenttext
A note kept with the zone.
Groupgroup_idtext
The group the zone belongs to. Defaults to the whole organization.
Report stops hereidentify_stopstrue/false
Name the zone when a vehicle stops in it, which also adds a zone stop rule.

Outputs

zoneobject
The zone as created
zone_idtext
The new zone's id
Example output
{
  "zone": {
    "activeFrom": "2026-11-17T14:00:00Z",
    "activeTo": "2050-01-01T00:00:00.000Z",
    "comment": "",
    "displayed": true,
    "groups": [
      {
        "id": "GroupCompanyId"
      }
    ],
    "id": "b4F",
    "mustIdentifyStops": false,
    "name": "Main depot",
    "points": [
      {
        "x": -79.7123,
        "y": 43.4392
      },
      {
        "x": -79.7111,
        "y": 43.4383
      },
      {
        "x": -79.7123,
        "y": 43.4374
      },
      {
        "x": -79.7135,
        "y": 43.4383
      },
      {
        "x": -79.7123,
        "y": 43.4392
      }
    ],
    "zoneTypes": [
      "ZoneTypeCustomerId"
    ]
  },
  "zone_id": "b4F"
}

Delete zone

Delete a zone for good.

Inputs

Zonezone_idtextRequired
The zone. Pick one, or give its id from an earlier step.

Outputs

deletedtrue/false
Always true once deleted
zone_idtext
The zone deleted
Example output
{
  "deleted": true,
  "zone_id": "b4F"
}

Get address at a location

Look up the street address at a latitude and longitude, such as a vehicle's position, and any zones it is in.

Inputs

LatitudelatitudenumberRequired
Latitude in decimal degrees, -90 to 90, such as 43.4383.From -90 to 90.
LongitudelongitudenumberRequired
Longitude in decimal degrees, -180 to 180, such as -79.7123.From -180 to 180.

Outputs

addressobject
The address, in parts
formatted_addresstext
The whole address on one line
Example output
{
  "address": {
    "city": "Oakville",
    "country": "Canada",
    "formattedAddress": "2440 Winston Park Dr, Oakville, ON L6H 7V2, Canada",
    "postalCode": "L6H 7V2",
    "region": "ON",
    "streetName": "Winston Park Dr",
    "streetNumber": "2440",
    "zones": [
      {
        "id": "b4F",
        "name": "Main depot"
      }
    ]
  },
  "formatted_address": "2440 Winston Park Dr, Oakville, ON L6H 7V2, Canada"
}

Get current user

Get the MyGeotab user the connection signs in as: name, email, time zone, groups and security clearance.

Inputs

None.

Outputs

userobject
The user
Example output
{
  "user": {
    "activeFrom": "2024-01-01T00:00:00.000Z",
    "activeTo": "2050-01-01T00:00:00.000Z",
    "comment": "",
    "companyGroups": [
      {
        "id": "GroupCompanyId"
      }
    ],
    "employeeNo": "",
    "firstName": "Jo",
    "id": "b1",
    "isDriver": false,
    "lastName": "Bloggs",
    "name": "fleet.manager@example.com",
    "phoneNumber": "",
    "securityGroups": [
      {
        "id": "GroupEverythingSecurityId"
      }
    ],
    "timeZoneId": "America/Toronto"
  }
}

Get duty status logs

Get hours-of-service duty status logs (driving, on duty, off duty and so on) in a time window, for a driver, a vehicle or everyone.

Inputs

Driverdriver_idtext
Only this driver. Leave empty for every driver.
Vehiclevehicle_idtext
Only this vehicle. Leave empty for every vehicle.
Statusesstatuseslist
Only logs with these statuses. Leave empty for all.One or more of: D (Driving), ON (On duty), OFF (Off duty), SB (Sleeper berth), PC (Personal conveyance), YM (Yard move), WT (Wait time).
Fromfrom_timedate and time
Start of the time window. Defaults to seven days before its end.
Toto_timedate and time
End of the time window. Defaults to now.
Most to returnlimitnumber
How many to return at most, 1 to 5,000. Defaults to 100.From 1 to 5000.

Outputs

countnumber
How many were returned
duty_status_logslist
The logs
Example output
{
  "count": 1,
  "duty_status_logs": [
    {
      "annotations": [],
      "dateTime": "2026-11-17T13:10:00.000Z",
      "device": {
        "id": "b3"
      },
      "driver": {
        "id": "b2A"
      },
      "id": "b8B2",
      "origin": "Automatic",
      "state": "Active",
      "status": "D"
    }
  ]
}

Get engine readings

Get a vehicle's readings of one measure, such as odometer, engine hours or fuel level, in a time window.

Inputs

Vehiclevehicle_idtextRequired
The vehicle. Pick one, or give its id from an earlier step.
ReadingdiagnostictextRequired
What to read.One of: DiagnosticOdometerId (Odometer (metres)), DiagnosticEngineHoursId (Engine hours (seconds)), DiagnosticFuelLevelId (Fuel level), DiagnosticDeviceTotalFuelId (Total fuel used), DiagnosticDeviceTotalIdleFuelId (Total fuel used idling), DiagnosticEngineSpeedId (Engine speed (RPM)), DiagnosticEngineRoadSpeedId (Road speed reported by the engine), DiagnosticEngineCoolantTemperatureId (Engine coolant temperature), DiagnosticOutsideTemperatureId (Outside temperature), DiagnosticGoDeviceVoltageId (Voltage at the GO device), DiagnosticStateOfChargeId (Electric vehicle battery charge), DiagnosticIgnitionId (Ignition on or off).
Fromfrom_timedate and time
Start of the time window. Defaults to seven days before its end.
Toto_timedate and time
End of the time window. Defaults to now.
Most to returnlimitnumber
How many to return at most, 1 to 5,000. Defaults to 100.From 1 to 5000.

Outputs

countnumber
How many were returned
readingslist
The readings, each in 'data'
Example output
{
  "count": 1,
  "readings": [
    {
      "data": 84213500,
      "dateTime": "2026-11-17T13:42:30.000Z",
      "device": {
        "id": "b3"
      },
      "diagnostic": {
        "id": "DiagnosticOdometerId"
      },
      "id": "b9C8"
    }
  ]
}

Get fault codes

Get engine and device fault codes recorded in a time window, for a vehicle or the fleet, with their state and warning lamps.

Inputs

Vehiclevehicle_idtext
Only this vehicle. Leave empty for every vehicle.
Fromfrom_timedate and time
Start of the time window. Defaults to seven days before its end.
Toto_timedate and time
End of the time window. Defaults to now.
Most to returnlimitnumber
How many to return at most, 1 to 5,000. Defaults to 100.From 1 to 5000.

Outputs

countnumber
How many were returned
faultslist
The fault records
Example output
{
  "count": 1,
  "faults": [
    {
      "amberWarningLamp": false,
      "controller": {
        "id": "ControllerObdPowertrainId"
      },
      "count": 1,
      "dateTime": "2026-11-17T09:15:00.000Z",
      "device": {
        "id": "b3"
      },
      "diagnostic": {
        "id": "aXn2Wm0z4dE6Hqz5vT1ABCD"
      },
      "failureMode": {
        "id": "NoFailureModeId"
      },
      "faultState": "Active",
      "id": "b5D4",
      "malfunctionLamp": true,
      "protectWarningLamp": false,
      "redStopLamp": false
    }
  ]
}

Get GPS history

Get a vehicle's recorded positions and speeds (km/h) in a time window, oldest first.

Inputs

Vehiclevehicle_idtextRequired
The vehicle. Pick one, or give its id from an earlier step.
Fromfrom_timedate and time
Start of the time window. Defaults to one day before its end.
Toto_timedate and time
End of the time window. Defaults to now.
Most to returnlimitnumber
How many to return at most, 1 to 5,000. Defaults to 100.From 1 to 5000.

Outputs

countnumber
How many were returned
logslist
The GPS points
Example output
{
  "count": 1,
  "logs": [
    {
      "dateTime": "2026-11-17T13:20:05.000Z",
      "device": {
        "id": "b3"
      },
      "id": "b1A2B3",
      "latitude": 43.4383,
      "longitude": -79.7123,
      "speed": 52
    }
  ]
}

Get rule violations

Get the exception events (rule violations, such as speeding) raised in a time window, for a rule, a vehicle or the fleet.

Inputs

Rulerule_idtext
Only violations of this rule. Leave empty for every rule.
Vehiclevehicle_idtext
Only this vehicle. Leave empty for every vehicle.
Fromfrom_timedate and time
Start of the time window. Defaults to seven days before its end.
Toto_timedate and time
End of the time window. Defaults to now.
Most to returnlimitnumber
How many to return at most, 1 to 5,000. Defaults to 100.From 1 to 5000.

Outputs

countnumber
How many were returned
exception_eventslist
The violations
Example output
{
  "count": 1,
  "exception_events": [
    {
      "activeFrom": "2026-11-17T13:25:00.000Z",
      "activeTo": "2026-11-17T13:26:10.000Z",
      "device": {
        "id": "b3"
      },
      "distance": 1.6,
      "driver": {
        "id": "b2A"
      },
      "duration": "00:01:10",
      "id": "b2E7",
      "rule": {
        "id": "RulePostedSpeedingId"
      }
    }
  ]
}

Get trips

Get the trips driven in a time window, for a vehicle, a driver or the fleet: start, stop, distance (km), speeds (km/h), idling and where each ended.

Inputs

Vehiclevehicle_idtext
Only this vehicle. Leave empty for every vehicle.
Driverdriver_idtext
Only this driver. Leave empty for every driver.
Fromfrom_timedate and time
Start of the time window. Defaults to seven days before its end.
Toto_timedate and time
End of the time window. Defaults to now.
Most to returnlimitnumber
How many to return at most, 1 to 5,000. Defaults to 100.From 1 to 5000.

Outputs

countnumber
How many were returned
tripslist
The trips
Example output
{
  "count": 1,
  "trips": [
    {
      "afterHoursEnd": false,
      "afterHoursStart": false,
      "averageSpeed": 34,
      "device": {
        "id": "b3"
      },
      "distance": 18.4,
      "driver": {
        "id": "b2A"
      },
      "drivingDuration": "00:32:30",
      "id": "b7F2",
      "idlingDuration": "00:03:10",
      "isSeatBeltOff": false,
      "maximumSpeed": 82,
      "nextTripStart": "2026-11-17T14:20:00.000Z",
      "start": "2026-11-17T13:10:00.000Z",
      "stop": "2026-11-17T13:42:30.000Z",
      "stopDuration": "00:37:30",
      "stopPoint": {
        "x": -79.7123,
        "y": 43.4383
      }
    }
  ]
}

Get user

Get one MyGeotab user or driver with their email, employee number, groups and whether they are a driver.

Inputs

Usergeotab_user_idtextRequired
The user or driver. Pick one, or give their id.

Outputs

userobject
The user
Example output
{
  "user": {
    "activeFrom": "2024-01-01T00:00:00.000Z",
    "activeTo": "2050-01-01T00:00:00.000Z",
    "comment": "",
    "companyGroups": [
      {
        "id": "GroupCompanyId"
      }
    ],
    "employeeNo": "",
    "firstName": "Sam",
    "id": "b2A",
    "isDriver": true,
    "lastName": "Driver",
    "name": "sam.driver@example.com",
    "phoneNumber": "",
    "securityGroups": [
      {
        "id": "GroupEverythingSecurityId"
      }
    ],
    "timeZoneId": "America/Toronto"
  }
}

Get vehicle

Get one vehicle with its serial number, plate, VIN, comment and groups.

Inputs

Vehiclevehicle_idtextRequired
The vehicle. Pick one, or give its id from an earlier step.

Outputs

vehicleobject
The vehicle
Example output
{
  "vehicle": {
    "activeFrom": "2024-01-01T00:00:00.000Z",
    "activeTo": "2050-01-01T00:00:00.000Z",
    "comment": "",
    "deviceType": "GO9",
    "groups": [
      {
        "id": "GroupCompanyId"
      }
    ],
    "id": "b3",
    "licensePlate": "ABCD 123",
    "licenseState": "ON",
    "name": "Van 12",
    "serialNumber": "G9A1B2C3D4E5",
    "timeZoneId": "America/Toronto",
    "vehicleIdentificationNumber": "1FTBW2CM5HKA12345"
  }
}

Get vehicle locations

Get where vehicles are now: position, speed, heading, driver and whether each is driving, for one vehicle, a group or the fleet (Geotab returns up to 50 at a time).

Inputs

Vehiclevehicle_idtext
Only this vehicle. Leave empty for every vehicle.
Groupgroup_idtext
Only vehicles in this group. Leave empty with no vehicle for the whole fleet.
Most to returnlimitnumber
How many to return at most, 1 to 50. Defaults to 50.From 1 to 50.

Outputs

countnumber
How many were returned
locationslist
Each vehicle's latest status
Example output
{
  "count": 1,
  "locations": [
    {
      "bearing": 90,
      "currentStateDuration": "00:12:05",
      "dateTime": "2026-11-17T14:02:11.000Z",
      "device": {
        "id": "b3"
      },
      "driver": {
        "id": "b2A"
      },
      "groups": [
        {
          "id": "GroupCompanyId"
        }
      ],
      "id": "b3",
      "isDeviceCommunicating": true,
      "isDriving": true,
      "latitude": 43.4383,
      "longitude": -79.7123,
      "speed": 48
    }
  ]
}

List groups

List the organization's groups (such as regions or departments), each with its parent and the groups under it.

Inputs

None.

Outputs

countnumber
How many were returned
groupslist
The groups
Example output
{
  "count": 1,
  "groups": [
    {
      "children": [
        {
          "id": "b27"
        }
      ],
      "comments": "",
      "id": "GroupCompanyId",
      "name": "",
      "parent": {
        "id": "GroupRootId"
      },
      "reference": ""
    }
  ]
}

List messages

List text messages sent to or from vehicles in a time window, with when each was sent, delivered and read.

Inputs

Vehiclevehicle_idtext
Only this vehicle. Leave empty for every vehicle.
Directiondirectiontext
Messages to vehicles, from vehicles, or both.One of: both (Both ways (default)), to_vehicles (Sent to vehicles), from_vehicles (Sent from vehicles).
Fromfrom_timedate and time
Start of the time window. Defaults to seven days before its end.
Toto_timedate and time
End of the time window. Defaults to now.
Most to returnlimitnumber
How many to return at most, 1 to 5,000. Defaults to 100.From 1 to 5000.

Outputs

countnumber
How many were returned
text_messageslist
The messages
Example output
{
  "count": 1,
  "text_messages": [
    {
      "delivered": "2026-11-17T14:05:04.000Z",
      "device": {
        "id": "b3"
      },
      "id": "b6A1",
      "isDirectionToVehicle": true,
      "messageContent": {
        "contentType": "Normal",
        "message": "Please call the depot when you stop.",
        "urgent": false
      },
      "read": "2026-11-17T14:06:20.000Z",
      "sent": "2026-11-17T14:05:00.000Z",
      "user": {
        "id": "b1"
      }
    }
  ]
}

List rules

List the rules that raise exception events, such as speeding, harsh braking or after-hours use.

Inputs

Name containsnametext
Only those whose name contains this text.
Kindrule_typetext
Only rules of this kind. Leave empty for every kind.One of: Custom (Rules your organization made), Stock (Geotab's built-in rules), ZoneStop (Stops in a zone).

Outputs

countnumber
How many were returned
ruleslist
The rules
Example output
{
  "count": 1,
  "rules": [
    {
      "activeFrom": "2024-01-01T00:00:00.000Z",
      "activeTo": "2050-01-01T00:00:00.000Z",
      "baseType": "Stock",
      "comment": "",
      "groups": [
        {
          "id": "GroupCompanyId"
        }
      ],
      "id": "RulePostedSpeedingId",
      "name": "Speeding"
    }
  ]
}

List users

List MyGeotab users, or only drivers, by name.

Inputs

Name containsnametext
Only people whose full name contains this text.
Drivers onlydrivers_onlytrue/false
Only users set up as drivers.
Include archivedinclude_archivedtrue/false
Also list ones archived in MyGeotab. Off lists only active ones.
Most to returnlimitnumber
How many to return at most, 1 to 5,000. Defaults to 100.From 1 to 5000.

Outputs

countnumber
How many were returned
userslist
The users
Example output
{
  "count": 2,
  "users": [
    {
      "activeFrom": "2024-01-01T00:00:00.000Z",
      "activeTo": "2050-01-01T00:00:00.000Z",
      "comment": "",
      "companyGroups": [
        {
          "id": "GroupCompanyId"
        }
      ],
      "employeeNo": "",
      "firstName": "Jo",
      "id": "b1",
      "isDriver": false,
      "lastName": "Bloggs",
      "name": "fleet.manager@example.com",
      "phoneNumber": "",
      "securityGroups": [
        {
          "id": "GroupEverythingSecurityId"
        }
      ],
      "timeZoneId": "America/Toronto"
    },
    {
      "activeFrom": "2024-01-01T00:00:00.000Z",
      "activeTo": "2050-01-01T00:00:00.000Z",
      "comment": "",
      "companyGroups": [
        {
          "id": "GroupCompanyId"
        }
      ],
      "employeeNo": "",
      "firstName": "Sam",
      "id": "b2A",
      "isDriver": true,
      "lastName": "Driver",
      "name": "sam.driver@example.com",
      "phoneNumber": "",
      "securityGroups": [
        {
          "id": "GroupEverythingSecurityId"
        }
      ],
      "timeZoneId": "America/Toronto"
    }
  ]
}

List vehicles

List the vehicles (GO devices) in the database, by name or group: name, serial number, plate, VIN and groups.

Inputs

Name containsnametext
Only those whose name contains this text.
Groupgroup_idtext
Only vehicles in this group or the groups under it.
Include archivedinclude_archivedtrue/false
Also list ones archived in MyGeotab. Off lists only active ones.
Most to returnlimitnumber
How many to return at most, 1 to 5,000. Defaults to 100.From 1 to 5000.

Outputs

countnumber
How many were returned
vehicleslist
The vehicles
Example output
{
  "count": 1,
  "vehicles": [
    {
      "activeFrom": "2024-01-01T00:00:00.000Z",
      "activeTo": "2050-01-01T00:00:00.000Z",
      "comment": "",
      "deviceType": "GO9",
      "groups": [
        {
          "id": "GroupCompanyId"
        }
      ],
      "id": "b3",
      "licensePlate": "ABCD 123",
      "licenseState": "ON",
      "name": "Van 12",
      "serialNumber": "G9A1B2C3D4E5",
      "timeZoneId": "America/Toronto",
      "vehicleIdentificationNumber": "1FTBW2CM5HKA12345"
    }
  ]
}

List zones

List the zones (geofences) active now, such as customer sites and depots, with their outlines.

Inputs

Name containsnametext
Only those whose name contains this text.
Most to returnlimitnumber
How many to return at most, 1 to 5,000. Defaults to 100.From 1 to 5000.

Outputs

countnumber
How many were returned
zoneslist
The zones
Example output
{
  "count": 1,
  "zones": [
    {
      "activeFrom": "2026-11-17T14:00:00Z",
      "activeTo": "2050-01-01T00:00:00.000Z",
      "comment": "",
      "displayed": true,
      "groups": [
        {
          "id": "GroupCompanyId"
        }
      ],
      "id": "b4F",
      "mustIdentifyStops": false,
      "name": "Main depot",
      "points": [
        {
          "x": -79.7123,
          "y": 43.4392
        },
        {
          "x": -79.7111,
          "y": 43.4383
        },
        {
          "x": -79.7123,
          "y": 43.4374
        },
        {
          "x": -79.7135,
          "y": 43.4383
        },
        {
          "x": -79.7123,
          "y": 43.4392
        }
      ],
      "zoneTypes": [
        "ZoneTypeCustomerId"
      ]
    }
  ]
}

Send message to vehicle

Send a text message to a vehicle's driver, shown in Geotab Drive or on the vehicle's connected display, from the connected user.

Inputs

Vehiclevehicle_idtextRequired
The vehicle. Pick one, or give its id from an earlier step.
MessagemessagetextRequired
What to say, up to 1,000 characters.
Urgenturgenttrue/false
Sound an alert in Geotab Drive even while the vehicle is moving.

Outputs

message_idtext
The message's id
text_messageobject
The message as sent
Example output
{
  "message_id": "b6A1",
  "text_message": {
    "device": {
      "id": "b3"
    },
    "id": "b6A1",
    "isDirectionToVehicle": true,
    "messageContent": {
      "contentType": "Normal",
      "message": "Please call the depot when you stop.",
      "urgent": false
    },
    "user": {
      "id": "b1"
    }
  }
}

Update vehicle

Change a vehicle's name, licence plate, plate state or province, VIN or comment. Only the fields given change.

Inputs

Vehiclevehicle_idtextRequired
The vehicle. Pick one, or give its id from an earlier step.
Namenametext
A new name, up to 50 characters. Leave empty to keep it.
Licence platelicense_platetext
A new licence plate. Leave empty to keep it.
Plate state or provincelicense_statetext
Where the plate is registered, such as ON or TX.
VINvintext
The vehicle identification number. Leave empty to keep it.
Commentcommenttext
A new comment. Leave empty to keep it.

Outputs

changed_fieldslist
The Geotab fields that were changed
vehicleobject
The vehicle as saved
Example output
{
  "changed_fields": [
    "name"
  ],
  "vehicle": {
    "activeFrom": "2024-01-01T00:00:00.000Z",
    "activeTo": "2050-01-01T00:00:00.000Z",
    "comment": "",
    "deviceType": "GO9",
    "groups": [
      {
        "id": "GroupCompanyId"
      }
    ],
    "id": "b3",
    "licensePlate": "ABCD 123",
    "licenseState": "ON",
    "name": "Van 12 (Oakville)",
    "serialNumber": "G9A1B2C3D4E5",
    "timeZoneId": "America/Toronto",
    "vehicleIdentificationNumber": "1FTBW2CM5HKA12345"
  }
}

Update zone

Rename a zone or change its comment, keeping its outline and everything else.

Inputs

Zonezone_idtextRequired
The zone. Pick one, or give its id from an earlier step.
Namenametext
A new name. Leave empty to keep it.
Commentcommenttext
A new comment. Leave empty to keep it.

Outputs

changed_fieldslist
The Geotab fields that were changed
zoneobject
The zone as saved
Example output
{
  "changed_fields": [
    "name"
  ],
  "zone": {
    "activeFrom": "2026-11-17T14:00:00Z",
    "activeTo": "2050-01-01T00:00:00.000Z",
    "comment": "",
    "displayed": true,
    "groups": [
      {
        "id": "GroupCompanyId"
      }
    ],
    "id": "b4F",
    "mustIdentifyStops": false,
    "name": "Main depot (north)",
    "points": [
      {
        "x": -79.7123,
        "y": 43.4392
      },
      {
        "x": -79.7111,
        "y": 43.4383
      },
      {
        "x": -79.7123,
        "y": 43.4374
      },
      {
        "x": -79.7135,
        "y": 43.4383
      },
      {
        "x": -79.7123,
        "y": 43.4392
      }
    ],
    "zoneTypes": [
      "ZoneTypeCustomerId"
    ]
  }
}

On this page