Skip to main content

Documentation Index

Fetch the complete documentation index at: https://api-docs.hellotracks.com/llms.txt

Use this file to discover all available pages before exploring further.

Update one or more properties of an existing member. You can modify profile information, status, role, team assignments, working hours, preferences, and more.

​
REQUEST

POST https://api.hellotracks.com/api/editaccount

{
   "data": {
      "account": "worker@company.com",
      "status_label": "Available",
      "phone": "+14155551234",
      "email": "newemail@company.com",
      "name": "Updated Name",
      "role": "dispatcher",
      "teams": [1, 2, 3],
      "vehicle_capacity": 500,
      "color": "#FF5733"
   }
}

​
Identifying the Member

​
account
string
One of account or uid is required to identify which member to edit.The username (email) of the member to edit.Example: "worker@company.com"
​
uid
string
One of account or uid is required to identify which member to edit.The unique identifier of the member to edit. Alternative to account.Example: "abc123"

​
Editable Properties

You can update any writable field from the Member API Object. Common editable properties include:

​
Core Information

  • name - Full name
  • phone - Phone number
  • email - Email address
  • color - Display color (hex format)

​
Role & Permissions

  • role - User role: “worker”, “operator”/“dispatcher”, or “administrator”
  • teams - Array of team numbers (integers)

​
Status & Availability

  • status_label - Custom status text (e.g., “Available”, “On break”)
  • status_label_ts - Timestamp when status was set (auto-updated)
  • moving - Movement status: “halted”, “idling”, “ontheway”, “offduty”

​
Vehicle & Capacity

  • vehicle_capacity - Vehicle capacity (weight/volume)
  • travel_mode - “car”, “bicycle”, “pedestrian”, “truck”, “van”, “motorcycle”

​
Working Hours

  • working_hours - Object with day-specific schedules (monday-sunday)
  • ignore_working_hours_until_ts - Temporary availability override

​
Route & Navigation

  • route_start_lat, route_start_lng - Daily route start location
  • route_end_lat, route_end_lng - Daily route end location
  • route_start_time - Daily start time in minutes from midnight

​
Preferences

  • unit_distance - “SI” (metric) or “US” (imperial)
  • unit_time - “12” or “24” hour format
  • date_format - Date format string (e.g., “dd.MM.yyyy”, “MM/dd/yyyy”)
  • timezone - Timezone string (e.g., “America/New_York”)
  • locale - Locale code (e.g., “en”, “de”, “fr”)

​
Skills & Capabilities

  • skills - Array of skill tags for job matching
  • expertise - Expertise level or specialty
See the Member API Object for the complete list of 55+ properties and their descriptions.

​
Permissions

  • Administrators: Can edit all members
  • Dispatchers: Can edit workers (limited permissions)
  • Workers: Can only edit their own profile (limited fields)
  • You must have appropriate permissions for the target member

​
RESPONSE

{
  "status": 0,
  "account": {
    "uid": "abc123",
    "username": "worker@company.com",
    "name": "Updated Name",
    "status_label": "Available",
    // ... complete updated member object
  }
}
​
status
integer
required
Status code. 0 indicates success.
​
account
object
Updated member object with all current properties. May be null if member was not found or no changes were made.See the Member API Object for complete structure.

​
Examples

curl -X POST https://api.hellotracks.com/api/editaccount \
  --header 'API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  -d '{
    "data": {
      "account": "worker@company.com",
      "status_label": "On Lunch Break"
    }
  }'
Partial Updates: Only include the fields you want to change. Omitted fields will remain unchanged.
Complete Field Reference: See the Member API Object for documentation of all editable properties, their types, valid values, and descriptions.