Skip to main content
PATCH
Change the company

Authorizations

API-Key
string
header
required

Your API key, from More → API & Integrations in the dashboard, or from ht signup / ht auth login.

Body

application/json

Flat: settings are sent at the top level (not inside settings, as GET returns them). Only fields sent are changed; unknown fields are refused with 400.

name
string
address
string
phone
string
email
string
apiEnabled
boolean

The company may use the API.

workersCreateJobs
boolean

Workers may create jobs in the app.

workersEditJob
boolean

Workers may edit their jobs.

workersCreatePlaces
boolean

Workers may create places.

workersViewPlaces
boolean

Workers see the company's places.

workersOptimizeRoute
boolean

Workers may optimize their own route.

workersViewJobCalendar
boolean

Workers see the job calendar.

assistantEnabled
boolean

The in-app assistant is on.

tripsEnabled
boolean

Trips (mileage log) are on.

jobGroupsEnabled
boolean

Job groups are on.

snoozeNotifications
boolean

Notifications are snoozed.

routeCalcIncludeCompany
boolean

Route calculation starts and ends at the company address.

etaPageDefaultShowWorkerName
boolean

The ETA page shows the worker's name by default.

etaPageDefaultShowMap
boolean

The ETA page shows the map by default.

workersEditTrips
boolean

Workers may edit their trips.

tripsRequireApproval
boolean

Trips need an admin's approval.

workersEditWorkingHours
boolean

Workers may edit their own working hours.

workersWebForms
boolean

Workers fill forms on the web.

workersAllowedTrackingOff
boolean

Workers may switch tracking off.

autoCheckins
boolean

Automatic check-ins at places are on (default true).

Response

The changed company.

data
object
required
error
null
required
meta
object
required