Skip to navigation
TelematicsDrivers & Users

🧪 Update User

Update an existing user. The user will be updated asynchronously, and you can check the status of the operation using the returned operation ID.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequiredformat: "uuid"
The unique identifier of the user

Query parameters

is_syncbooleanOptionalDefaults to false

Whether to process the request synchronously. If true, Catena will attempt to create or update the resource immediately with the TSP and return the result in the response. When performing synchronous operations, you are responsible for handling any necessary retries in case of transient failures.If false (default), Catena will create an asynchronous operation, and you can check the status of the operation using the returned operation ID.

Request

This endpoint expects an object.
connection_idstringRequiredformat: "uuid"

Unique identifier of the connection at Catena Telematics which will be used to create this resource. A connection represents a Fleet/TSP pairing.

usernamestring or nullOptional

Unique username/login for the user (source or Catena).

is_activeboolean or nullOptional
Indicates whether the user is currently active.
statusenum or nullOptional

User/account status label (e.g., ‘ACTIVE’, ‘INACTIVE’, ‘SUSPENDED’).

Allowed values:
is_driverboolean or nullOptional

Indicates whether the user is a driver (vs. back-office/admin).

user_designationstring or nullOptional

Role/title or TSP designation (e.g., ‘DRIVER’, ‘DISPATCHER’, ‘ADMIN’).

user_emailstring or nullOptional
Email address for the user.
first_namestring or nullOptional
User's given name.
passwordstring or nullOptionalformat: "password"1-1024 characters
Password associated with the user.
last_namestring or nullOptional

User’s family/surname.

phone_numberstring or nullOptional
User's phone number.
country_codestring or nullOptionalformat: "^\w{3}$"

User’s country code (ISO-3166-1 alpha-3, e.g., ‘USA’, ‘CAN’).

license_countrystring or nullOptionalformat: "^\w{3}$"

Issuing country for the driver’s license (ISO-3166-1 alpha-3, e.g., ‘USA’, ‘CAN’).

license_regionstring or nullOptional

Issuing region/subdivision for the license (state/province code, e.g., ‘CA’, ‘ON’).

license_numberstring or nullOptional
Driver's license number as recorded by the source.
license_expirationdate or nullOptional

License expiration date (YYYY-MM-DD, local to issuing authority).

employee_numberstring or nullOptional

Employer/HR or payroll identifier for the user (if applicable).

carrier_numberstring or nullOptional

Carrier/company identifier as provided by the TSP (e.g., USDOT/MC or internal).

notesstring or nullOptional

Free-text notes about the user (plain text).

hos_ruleset_codeenum or nullOptional

Assigned HOS ruleset code for the user (normalized; see ref_hos_ruleset_codes).

hos_ruleset_namestring or nullOptional

Human-readable name of the HOS ruleset assigned to the user (e.g., ‘US Property (60/7)’).

allow_yard_moveboolean or nullOptional

Indicates whether the user is allowed to use Yard Move (YM).

allow_personal_conveyanceboolean or nullOptional

Indicates whether the user is allowed to use Personal Conveyance (PC).

allow_adverse_drivingboolean or nullOptional
Indicates whether the user can apply the Adverse Driving exemption.
default_time_zoneenum or nullOptional

IANA time zone ID (e.g., ‘America/Chicago’); used as the user’s default for UI/log normalization.

dot_idstring or nullOptional

DOT identifier associated with the user/carrier.

phone_country_codestring or nullOptional

Phone country code in ’+<digits>’ format, e.g., ‘+1’.

hos_tracking_modeobject or nullOptional
Normalized HOS tracking configuration.
hos_compliance_typeenum or nullOptional

Driver HOS compliance classification: exempt or non-exempt.

Allowed values:
hos_tracking_methodenum or nullOptional

How HOS is tracked for non-exempt drivers when the source distinguishes tracking method (manual or automatic).

Allowed values:

Response

The user was updated successfully.
partner_idstringformat: "uuid"
The ID of the partner that created the operation.
connection_idstringformat: "uuid"
The ID of the connection
resourceenum

The type of resource to operate on (e.g., vehicle, driver).

operation_typeenum

The type of operation to perform (e.g., create, update).

Allowed values:
payloadmap from strings to any
The payload of the operation, containing the resource attributes to be created or updated.
idstringOptionalformat: "uuid"
Unique identifier for the resource operation.
created_atdatetimeOptional

Immutable: The datetime the record was created in Catena Telematics.

updated_atdatetimeOptional
The datetime the record was last modified in Catena Telematics.
deleted_atdatetime or nullOptional
The datetime the record was logically deleted from Catena Telematics.
resource_idstring or nullOptionalformat: "uuid"

Unique identifier of the record. Can be null for create operations where the source does not exist yet.

source_idstring or nullOptional
The unique identifier of the resource in the source system. Required for update operations.
statusenumOptional
The status of the operation
Allowed values:
logslist of objectsOptional
Log entries for each attempt to execute this operation.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
405
Method Not Allowed Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
501
Not Implemented Error
502
Bad Gateway Error