Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/ShohjahonSohibov/repo-for-agent/llms.txt

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

The Settings API exposes every configuration surface in UpdaterAgent — from global system preferences and third-party integration credentials to per-user notification rules and Telegram bot permissions. Most endpoints are company-scoped and enforce specific permission codes so that only authorized administrators can make changes. The same section also covers tenant and company management for multi-tenant deployments, and full user account administration including activation, deactivation, and password reset.

​
GeneralSettingsController — /api/general-settings

Read and update system-wide general settings.
MethodEndpointPermissionDescription
GET/api/general-settingsSettings.ViewGet current general settings
PUT/api/general-settingsSettings.UpdateUpdate general settings
cURL
curl https://your-domain.com/api/general-settings \
  -H "Authorization: Bearer <accessToken>"

​
TmsSettingsController — /api/tms-settings

Configure the TMS integration for a company. Each company stores its own TMS credentials independently.

​
GET /api/tms-settings

Retrieve the current TMS integration settings for the authenticated user’s company. Required permission: TmsSettings.View Response fields
​
provider
string
required
The configured TMS provider (e.g., QuickManage).
​
apiUrl
string
required
The base URL used to call the TMS API.
​
isConnected
boolean
required
Whether the last connection test succeeded.

​
PUT /api/tms-settings

Update TMS integration credentials and configuration. Required permission: TmsSettings.Update
​
apiUrl
string
The TMS API base URL.
​
apiKey
string
API key or bearer token for authenticating with the TMS.
cURL
curl -X PUT https://your-domain.com/api/tms-settings \
  -H "Authorization: Bearer <accessToken>" \
  -H "Content-Type: application/json" \
  -d '{
    "apiUrl": "https://api.quickmanage.com",
    "apiKey": "qm_live_abc123"
  }'

​
POST /api/tms-settings/test-connection

Test the current TMS configuration by making a lightweight call to the TMS API. Returns success or an error describing the failure. Required permission: TmsSettings.Update
cURL
curl -X POST https://your-domain.com/api/tms-settings/test-connection \
  -H "Authorization: Bearer <accessToken>"
Response (success)
{ "success": true, "message": "Connection to QuickManage established." }
Response (failure)
{ "success": false, "message": "401 Unauthorized: Invalid API key." }

​
EldSettingsController — /api/eld-settings

Configure the ELD (Electronic Logging Device) integration for a company. Supports UTrackin, Zippy, Samsara, LevelELD, and OnTimeLogs.

​
GET /api/eld-settings

Retrieve the current ELD integration settings for the authenticated user’s company. Required permission: EldSettings.View

​
PUT /api/eld-settings

Update ELD credentials and configuration. Required permission: EldSettings.Update
​
provider
string
ELD provider identifier (e.g., UTrackin, Zippy, Samsara).
​
apiKey
string
API key or credentials for the ELD provider.

​
POST /api/eld-settings/test-connection

Test the current ELD configuration. Returns whether the connection succeeds and any error detail. Required permission: EldSettings.Update
cURL
curl -X POST https://your-domain.com/api/eld-settings/test-connection \
  -H "Authorization: Bearer <accessToken>"

​
NotificationSettingsController — /api/notification-settings

Control which system events trigger in-app and Telegram notifications, configurable per user or company.
MethodEndpointPermissionDescription
GET/api/notification-settingsSettings.ViewGet current notification settings
PUT/api/notification-settingsSettings.UpdateUpdate notification settings

​
BotPermissionsController — /api/bot-permissions

Manage which actions the Telegram bot is allowed to perform on behalf of your company.
MethodEndpointPermissionDescription
GET/api/bot-permissionsBotPermissions.ViewList all bot permissions
PUT/api/bot-permissions/{id}BotPermissions.UpdateEnable or disable a specific bot permission

​
SettingCategoriesController — /api/setting-categories

Retrieve the list of available setting categories. Used to render grouped settings UI.
MethodEndpointPermissionDescription
GET/api/setting-categoriesSettings.ViewList all setting categories

​
QuickActionButtonsController — /api/quick-action-buttons

Create and manage the customizable quick-action buttons that appear in the dispatcher UI.
MethodEndpointPermissionDescription
GET/api/quick-action-buttonsQuickActions.ViewList all quick action buttons
POST/api/quick-action-buttonsQuickActions.CreateCreate a quick action button
PUT/api/quick-action-buttons/{id}QuickActions.UpdateUpdate a quick action button
DELETE/api/quick-action-buttons/{id}QuickActions.DeleteDelete a quick action button

​
TenantsController — /api/tenants

Multi-tenant organization management. Tenant records sit at the top of the hierarchy and contain one or more companies.
MethodEndpointPermissionDescription
GET/api/tenantsTenants.ViewList all tenants
GET/api/tenants/{id}Tenants.ViewGet a tenant by ID
POST/api/tenantsTenants.CreateCreate a new tenant
PUT/api/tenants/{id}Tenants.UpdateUpdate tenant details
DELETE/api/tenants/{id}Tenants.DeleteDelete a tenant

​
CompanyController — /api/companies

Company management within tenants. A tenant can have multiple companies, each with their own settings, users, and loads.
MethodEndpointPermissionDescription
GET/api/companiesCompanies.ViewList companies (filtered by tenant)
GET/api/companies/{id}Companies.ViewGet a company by ID
POST/api/companiesCompanies.CreateCreate a new company
PUT/api/companies/{id}Companies.UpdateUpdate company details
DELETE/api/companies/{id}Companies.DeleteDelete a company
GET/api/companies/{id}/statisticsCompanies.ViewGet aggregate statistics for a company
cURL
curl https://your-domain.com/api/companies/3/statistics \
  -H "Authorization: Bearer <accessToken>"

​
UsersController — /api/users

Full user account management including creation, updates, activation/deactivation, and password reset.

​
Standard CRUD

MethodEndpointPermissionDescription
GET/api/usersUsers.ViewList users with pagination
GET/api/users/{id}Users.ViewGet a user by ID
POST/api/usersUsers.CreateCreate a new user
PUT/api/users/{id}Users.UpdateUpdate user details
DELETE/api/users/{id}Users.DeleteDelete a user

​
Account management

MethodEndpointPermissionDescription
GET/api/users/meAuthenticatedGet the current user’s profile
PUT/api/users/{id}/activateUsers.UpdateActivate a user account
PUT/api/users/{id}/deactivateUsers.UpdateDeactivate a user account
POST/api/users/{id}/reset-passwordUsers.UpdateSend a password reset for a user
cURL
# Get current user profile
curl https://your-domain.com/api/users/me \
  -H "Authorization: Bearer <accessToken>"

# Deactivate a user
curl -X PUT https://your-domain.com/api/users/9/deactivate \
  -H "Authorization: Bearer <accessToken>"
Deactivated users retain their records and audit history but cannot log in. Reactivate them at any time using PUT /api/users/{id}/activate.

Build docs developers (and LLMs) love

Get started for freeTalk to us