Change a member
curl --request PATCH \
--url https://api.hellotracks.com/v1/members/{id} \
--header 'API-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"username": "alex.rivera@example.com",
"routeStartTime": "team",
"travelMode": "truck",
"vehicleCapacity": 20,
"workingHoursOverrides": {
"20261224": {
"start": 800,
"end": 1200
}
}
}
'import requests
url = "https://api.hellotracks.com/v1/members/{id}"
payload = {
"username": "alex.rivera@example.com",
"routeStartTime": "team",
"travelMode": "truck",
"vehicleCapacity": 20,
"workingHoursOverrides": { "20261224": {
"start": 800,
"end": 1200
} }
}
headers = {
"API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
username: 'alex.rivera@example.com',
routeStartTime: 'team',
travelMode: 'truck',
vehicleCapacity: 20,
workingHoursOverrides: {'20261224': {start: 800, end: 1200}}
})
};
fetch('https://api.hellotracks.com/v1/members/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hellotracks.com/v1/members/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'username' => 'alex.rivera@example.com',
'routeStartTime' => 'team',
'travelMode' => 'truck',
'vehicleCapacity' => 20,
'workingHoursOverrides' => [
'20261224' => [
'start' => 800,
'end' => 1200
]
]
]),
CURLOPT_HTTPHEADER => [
"API-Key: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hellotracks.com/v1/members/{id}"
payload := strings.NewReader("{\n \"username\": \"alex.rivera@example.com\",\n \"routeStartTime\": \"team\",\n \"travelMode\": \"truck\",\n \"vehicleCapacity\": 20,\n \"workingHoursOverrides\": {\n \"20261224\": {\n \"start\": 800,\n \"end\": 1200\n }\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.hellotracks.com/v1/members/{id}")
.header("API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"username\": \"alex.rivera@example.com\",\n \"routeStartTime\": \"team\",\n \"travelMode\": \"truck\",\n \"vehicleCapacity\": 20,\n \"workingHoursOverrides\": {\n \"20261224\": {\n \"start\": 800,\n \"end\": 1200\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hellotracks.com/v1/members/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"username\": \"alex.rivera@example.com\",\n \"routeStartTime\": \"team\",\n \"travelMode\": \"truck\",\n \"vehicleCapacity\": 20,\n \"workingHoursOverrides\": {\n \"20261224\": {\n \"start\": 800,\n \"end\": 1200\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"member": {
"id": "a1b2c3",
"type": "person",
"username": "alex@example.com",
"name": "Alex Rivera",
"email": "alex@example.com",
"phone": "+1 415 555 0101",
"color": "#2f80ed",
"profileImageUrl": "",
"companyId": "c0c0c0",
"role": "worker",
"statusLabel": "",
"teams": [
1
],
"location": {
"lat": 37.7793,
"lng": -122.4193,
"ts": 1761980400000,
"head": 90,
"accuracy": 12,
"speed": 0
},
"units": {
"distance": "US",
"time": "12",
"date": "MM-dd-yyyy"
},
"locale": {
"language": "en",
"timezone": "America/Los_Angeles"
},
"routeStartLat": 37.7749,
"routeStartLng": -122.4194,
"routeEndLat": 37.7749,
"routeEndLng": -122.4194,
"travelMode": "car",
"vehicleCapacity": 0,
"routeStartTime": "08:00",
"workingHours": {
"monday": {
"start": 800,
"end": 1700
},
"tuesday": {
"start": 800,
"end": 1700
},
"wednesday": {
"start": 800,
"end": 1700
},
"thursday": {
"start": 800,
"end": 1700
},
"friday": {
"start": 800,
"end": 1700
},
"saturday": {
"start": 0,
"end": 0
},
"sunday": {
"start": 0,
"end": 0
},
"source": "individual"
},
"workingHoursOverrides": {
"20261224": {
"start": 800,
"end": 1200
}
},
"states": {
"moving": "halted",
"tracking_status": true,
"location_services": true,
"login_status": true,
"battery_save": false,
"off_trackrecording": false,
"ignoring_battery_optimization": true,
"off_gps_stationary": false,
"location_permission": true,
"background_location": true
},
"timestamps": {
"signal": 1761980400000,
"created": 1735689600000,
"login": 1761970000000,
"sync": 1761975000000,
"tracking": 1761970000000,
"suspended": 0,
"recovered": 0,
"invited": 1735689600000,
"reminded": 1735689600000
}
}
},
"error": null,
"meta": {
"path": "/v1/members/a1b2c3",
"method": "PATCH"
}
}{
"data": null,
"error": {
"code": "invalid_request",
"message": "date must be YYYY-MM-DD"
},
"meta": {
"path": "/jobs",
"method": "GET"
}
}{
"data": null,
"error": {
"code": "invalid_api_key",
"message": "Invalid Hellotracks API key."
},
"meta": {
"path": "/jobs",
"method": "GET"
}
}{
"data": null,
"error": {
"code": "forbidden",
"message": "No permission."
},
"meta": {
"path": "/jobs",
"method": "GET"
}
}{
"data": null,
"error": {
"code": "throttled",
"message": "Too many requests."
},
"meta": {
"path": "/jobs",
"method": "GET"
}
}Members
Change a member
Changes only the fields sent. Admins, operators and company keys may change members of their company; a worker only themself. username renames the member (company admins and company keys only; 403 otherwise; the same name is no change; a taken name answers 400); the old name keeps working as an alias. role changes only by admins or company keys, never one’s own. Workers may change their own working hours only when the company allows it (workersEditWorkingHours). A field that can’t be applied answers 400 (invalid_data) with a message naming it, for example “working_hours was not changed: …”; a refused role or working-hours change answers 403. Fields before it may already be saved. password is refused with 400: people set their password at live.hellotracks.com with “Forgot password?”. The member’s apps get the change.
PATCH
/
members
/
{id}
Change a member
curl --request PATCH \
--url https://api.hellotracks.com/v1/members/{id} \
--header 'API-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"username": "alex.rivera@example.com",
"routeStartTime": "team",
"travelMode": "truck",
"vehicleCapacity": 20,
"workingHoursOverrides": {
"20261224": {
"start": 800,
"end": 1200
}
}
}
'import requests
url = "https://api.hellotracks.com/v1/members/{id}"
payload = {
"username": "alex.rivera@example.com",
"routeStartTime": "team",
"travelMode": "truck",
"vehicleCapacity": 20,
"workingHoursOverrides": { "20261224": {
"start": 800,
"end": 1200
} }
}
headers = {
"API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
username: 'alex.rivera@example.com',
routeStartTime: 'team',
travelMode: 'truck',
vehicleCapacity: 20,
workingHoursOverrides: {'20261224': {start: 800, end: 1200}}
})
};
fetch('https://api.hellotracks.com/v1/members/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hellotracks.com/v1/members/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'username' => 'alex.rivera@example.com',
'routeStartTime' => 'team',
'travelMode' => 'truck',
'vehicleCapacity' => 20,
'workingHoursOverrides' => [
'20261224' => [
'start' => 800,
'end' => 1200
]
]
]),
CURLOPT_HTTPHEADER => [
"API-Key: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hellotracks.com/v1/members/{id}"
payload := strings.NewReader("{\n \"username\": \"alex.rivera@example.com\",\n \"routeStartTime\": \"team\",\n \"travelMode\": \"truck\",\n \"vehicleCapacity\": 20,\n \"workingHoursOverrides\": {\n \"20261224\": {\n \"start\": 800,\n \"end\": 1200\n }\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.hellotracks.com/v1/members/{id}")
.header("API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"username\": \"alex.rivera@example.com\",\n \"routeStartTime\": \"team\",\n \"travelMode\": \"truck\",\n \"vehicleCapacity\": 20,\n \"workingHoursOverrides\": {\n \"20261224\": {\n \"start\": 800,\n \"end\": 1200\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hellotracks.com/v1/members/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"username\": \"alex.rivera@example.com\",\n \"routeStartTime\": \"team\",\n \"travelMode\": \"truck\",\n \"vehicleCapacity\": 20,\n \"workingHoursOverrides\": {\n \"20261224\": {\n \"start\": 800,\n \"end\": 1200\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"member": {
"id": "a1b2c3",
"type": "person",
"username": "alex@example.com",
"name": "Alex Rivera",
"email": "alex@example.com",
"phone": "+1 415 555 0101",
"color": "#2f80ed",
"profileImageUrl": "",
"companyId": "c0c0c0",
"role": "worker",
"statusLabel": "",
"teams": [
1
],
"location": {
"lat": 37.7793,
"lng": -122.4193,
"ts": 1761980400000,
"head": 90,
"accuracy": 12,
"speed": 0
},
"units": {
"distance": "US",
"time": "12",
"date": "MM-dd-yyyy"
},
"locale": {
"language": "en",
"timezone": "America/Los_Angeles"
},
"routeStartLat": 37.7749,
"routeStartLng": -122.4194,
"routeEndLat": 37.7749,
"routeEndLng": -122.4194,
"travelMode": "car",
"vehicleCapacity": 0,
"routeStartTime": "08:00",
"workingHours": {
"monday": {
"start": 800,
"end": 1700
},
"tuesday": {
"start": 800,
"end": 1700
},
"wednesday": {
"start": 800,
"end": 1700
},
"thursday": {
"start": 800,
"end": 1700
},
"friday": {
"start": 800,
"end": 1700
},
"saturday": {
"start": 0,
"end": 0
},
"sunday": {
"start": 0,
"end": 0
},
"source": "individual"
},
"workingHoursOverrides": {
"20261224": {
"start": 800,
"end": 1200
}
},
"states": {
"moving": "halted",
"tracking_status": true,
"location_services": true,
"login_status": true,
"battery_save": false,
"off_trackrecording": false,
"ignoring_battery_optimization": true,
"off_gps_stationary": false,
"location_permission": true,
"background_location": true
},
"timestamps": {
"signal": 1761980400000,
"created": 1735689600000,
"login": 1761970000000,
"sync": 1761975000000,
"tracking": 1761970000000,
"suspended": 0,
"recovered": 0,
"invited": 1735689600000,
"reminded": 1735689600000
}
}
},
"error": null,
"meta": {
"path": "/v1/members/a1b2c3",
"method": "PATCH"
}
}{
"data": null,
"error": {
"code": "invalid_request",
"message": "date must be YYYY-MM-DD"
},
"meta": {
"path": "/jobs",
"method": "GET"
}
}{
"data": null,
"error": {
"code": "invalid_api_key",
"message": "Invalid Hellotracks API key."
},
"meta": {
"path": "/jobs",
"method": "GET"
}
}{
"data": null,
"error": {
"code": "forbidden",
"message": "No permission."
},
"meta": {
"path": "/jobs",
"method": "GET"
}
}{
"data": null,
"error": {
"code": "throttled",
"message": "Too many requests."
},
"meta": {
"path": "/jobs",
"method": "GET"
}
}Authorizations
Your API key, from More → API & Integrations in the dashboard, or from ht signup / ht auth login.
Path Parameters
Member id (6 characters).
Body
application/json
Fields for creating or changing a member. Unknown fields are refused with 400.
Login name, e.g. an email address. Required on create. On PATCH it renames the member (company admins only); the old name stays as an alias.
Full name. Required on create.
Create only: must be a strong password; without it the member gets a temporary one and sets their own via the invite. PATCH refuses it with 400.
worker (default), operator (or dispatcher), admin. Any other value means worker. Only admins and company keys may make admins or change roles, and never their own.
Examples:
"worker"
"operator"
"admin"
ISO 639-1, e.g. en.
IANA time zone.
Available options:
SI, US Available options:
12, 24 Date pattern, e.g. MM-dd-yyyy.
Available options:
car, bicycle, pedestrian, truck, van, motorcycle "HH:mm" (also H:mm or HHmm), a number in HHMM form (800), or "team" (or -1) to use the team's start time. null leaves it unchanged.
Team numbers; replaces all of the member's teams.
A week of working hours, one window per day, times as HHMM numbers. On write all 7 days are required; send {} to drop the member's own hours and use the team's again.
Show child attributes
Show child attributes
Single days with other hours, keyed by day as YYYYMMDD (8 digits). On write the whole set is replaced; other keys are ignored.
Show child attributes
Show child attributes