🧪 Create User - Catena Telematics API

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

is_sync

boolean

default: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.

Body

application/json

User model for creating new records

connection_id

string<uuid>

required

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

username

string | null

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

is_active

boolean | null

Indicates whether the user is currently active.

status

enum<string> | null

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

Available options:

ACTIVE,

INACTIVE

is_driver

boolean | null

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

user_designation

string | null

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

user_email

string | null

Email address for the user.

first_name

string | null

User's given name.

last_name

string | null

User's family/surname.

phone_number

string | null

User's phone number.

country_code

string | null

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

Pattern: ^\w{3}$

license_country

string | null

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

Pattern: ^\w{3}$

license_region

string | null

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

license_number

string | null

Driver's license number as recorded by the source.

license_expiration

string<date> | null

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

employee_number

string | null

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

carrier_number

string | null

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

notes

string | null

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

hos_ruleset_code

enum<string> | null

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

Available options:

US_INT_PROP_60_7,

US_INT_PROP_60_7_BIG,

US_INT_PROP_60_7_BIG_SLP,

US_INT_PROP_60_7_NORST,

US_INT_PROP_60_7_NORST_SLP,

US_INT_PROP_60_7_NOBRK,

US_INT_PROP_60_7_NOBRK_BIG,

US_INT_PROP_60_7_NOBRK_BIG_SLP,

US_INT_PROP_60_7_NOBRK_SLP,

US_INT_PROP_60_7_SH,

US_INT_PROP_60_7_SH_NORST,

US_INT_PROP_70_8,

US_INT_PROP_70_8_BIG,

US_INT_PROP_70_8_BIG_SLP,

US_INT_PROP_70_8_NORST,

US_INT_PROP_70_8_NORST_SLP,

US_INT_PROP_70_8_NOBRK,

US_INT_PROP_70_8_NOBRK_BIG,

US_INT_PROP_70_8_NOBRK_BIG_SLP,

US_INT_PROP_70_8_NOBRK_SLP,

US_INT_PROP_70_8_SH,

US_INT_PROP_70_8_SH_14H,

US_INT_PROP_70_8_SH_NORST,

US_INT_PROP_SH_14H,

US_INT_PAX_60_7,

US_INT_PAX_60_7_SH,

US_INT_PAX_70_8,

US_INT_PAX_70_8_SH,

US_INT_SALESP,

US_INT_SALESP_NCDL_SH,

US_INT_OILTR_60_7,

US_INT_OILTR_70_8,

US_INT_OILWL_60_7,

US_INT_OILWL_70_8,

US_INT_RAIL_EX,

US_INT_PROP_SLPVAR,

US_INT_PROP_60_7_SLPVAR,

US_INT_PROP_70_8_SLPVAR,

US_INT_CARRIER_EX,

US_INT_NOHOS_7,

US_INT_NOHOS_8,

US_TX_INTRA_PROP_70_7,

US_TX_INTRA_SH_70_7,

US_TX_INTRA_SH_70_8,

US_CA_INTRA_PROP_80_8,

US_CA_INTRA_PAX_80_8,

US_CA_INTRA_FARM_112_8,

US_CA_INTRA_FARM_BRK,

US_CA_INTRA_FLAM_80_8,

US_CA_INTRA_FLAM_BRK,

US_CA_INTRA_SCH_80_8,

US_CA_INTRA_SCH_BRK,

US_AK_INTRA_PROP_70_7,

US_AK_INTRA_PROP_80_8,

US_AK_INTRA_PAX_70_7,

US_AK_INTRA_PAX_80_8,

US_AK_INTRA_PROP_70_7_SLP,

US_AK_INTRA_PROP_80_8_SLP,

US_FL_INTRA_PROP_70_7,

US_FL_INTRA_PROP_80_8,

US_FL_INTRA_SH_70_7,

US_FL_INTRA_SH_80_8,

US_OR_INTRA_PROP_70_7,

US_OR_INTRA_PROP_80_8,

US_MD_INTRA_SH_70_7,

US_MD_INTRA_SH_80_8,

US_NE_INTRA_PROP_70_7,

US_NE_INTRA_PROP_80_8,

US_NC_INTRA_PROP_70_7,

US_NC_INTRA_PROP_80_8,

US_ND_INTRA_PROP_70_7,

US_ND_INTRA_SH_70_7,

US_SC_INTRA_PROP_70_7,

US_SC_INTRA_PROP_80_8,

US_WA_INTRA_PROP_70_7,

US_WA_INTRA_PROP_80_8,

US_WI_INTRA_PROP_70_7,

US_WI_INTRA_PROP_80_8,

CA_FED_C1_70_7,

CA_FED_C2_120_14,

CA_FED_C1_TEAM,

CA_FED_C2_TEAM,

CA_FED_NOHOS,

CA_N60_C1_80_7,

CA_N60_C2_120_14,

CA_N60_C1_TEAM,

CA_N60_C2_TEAM,

CA_N60_NOHOS,

CA_N60_OIL,

CA_N60_OIL_TEAM,

CA_AB_PROV_PROP_70_7,

CA_SK_PROV_PROP_70_7,

CA_SK_PROV_FERT_EX,

CA_BC_PROV_LOG,

CA_S60_OIL,

CA_OIL_TEAM,

US_INT_OILTR_60_7_BIG,

US_INT_OILTR_60_7_BIG_SLP,

US_INT_OILTR_60_7_SLP,

US_INT_OILTR_70_8_BIG,

US_INT_OILTR_70_8_BIG_SLP,

US_INT_OILTR_70_8_SLP,

US_CA_INTRA_OILTR_80_8,

US_CA_INTRA_OILTR_PROP,

US_INT_OILTR_60_7_NOBRK,

US_INT_OILTR_60_7_NOBRK_BIG,

US_INT_OILTR_60_7_NOBRK_BIG_SLP,

US_INT_OILTR_60_7_NOBRK_SLP,

US_INT_OILTR_70_8_NOBRK,

US_INT_OILTR_70_8_NOBRK_BIG,

US_INT_OILTR_70_8_NOBRK_BIG_SLP,

US_INT_OILTR_70_8_NOBRK_SLP,

US_INT_OILTR_SH_12H,

US_INT_OILTR_SH_14H,

US_INT_OILTR_70_8_SH_12H,

US_INT_OILTR_70_8_SH_14H,

US_TX_INTRA_OILTR_70_7,

US_INT_OILWL_60_7_BIG,

US_INT_OILWL_60_7_BIG_SLP,

US_INT_OILWL_60_7_SLP,

US_INT_OILWL_70_8_BIG,

US_INT_OILWL_70_8_BIG_SLP,

US_INT_OILWL_70_8_SLP,

US_CA_INTRA_OILWL_80_8,

US_CA_INTRA_OILWL_PROP,

US_INT_OILWL_60_7_NOBRK,

US_INT_OILWL_60_7_NOBRK_BIG,

US_INT_OILWL_60_7_NOBRK_BIG_SLP,

US_INT_OILWL_60_7_NOBRK_SLP,

US_INT_OILWL_70_8_NOBRK,

US_INT_OILWL_70_8_NOBRK_BIG,

US_INT_OILWL_70_8_NOBRK_BIG_SLP,

US_INT_OILWL_70_8_NOBRK_SLP,

US_TX_INTRA_OILWL_70_7

allow_yard_move

boolean | null

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

allow_personal_conveyance

boolean | null

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

allow_adverse_driving

boolean | null

Indicates whether the user can apply the Adverse Driving exemption.

default_time_zone

enum<string> | null

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

Available options:

UTC,

Pacific/Honolulu,

America/Adak,

America/Anchorage,

America/Juneau,

America/Metlakatla,

America/Nome,

America/Sitka,

America/Yakutat,

America/Los_Angeles,

America/Vancouver,

America/Boise,

America/Cambridge_Bay,

America/Creston,

America/Dawson,

America/Dawson_Creek,

America/Denver,

America/Edmonton,

America/Fort_Nelson,

America/Inuvik,

America/Phoenix,

America/Whitehorse,

America/Yellowknife,

America/Chicago,

America/Menominee,

America/North_Dakota/Beulah,

America/North_Dakota/Center,

America/North_Dakota/New_Salem,

America/Rainy_River,

America/Rankin_Inlet,

America/Regina,

America/Resolute,

America/Swift_Current,

America/Winnipeg,

America/Indiana/Knox,

America/Indiana/Tell_City,

America/Detroit,

America/Iqaluit,

America/Kentucky/Louisville,

America/Kentucky/Monticello,

America/New_York,

America/Nipigon,

America/Pangnirtung,

America/Thunder_Bay,

America/Toronto,

America/Indiana/Indianapolis,

America/Indiana/Marengo,

America/Indiana/Petersburg,

America/Indiana/Vevay,

America/Indiana/Vincennes,

America/Indiana/Winamac,

America/Atikokan,

America/Blanc-Sablon,

America/Glace_Bay,

America/Goose_Bay,

America/Halifax,

America/Moncton,

America/St_Johns,

America/Mexico_City,

America/Cancun,

America/Merida,

America/Monterrey,

America/Mazatlan,

America/Chihuahua,

America/Hermosillo,

America/Tijuana,

America/Matamoros,

America/Ojinaga,

America/Ciudad_Juarez,

America/Guatemala,

America/Belize,

America/Tegucigalpa,

America/Managua,

America/Costa_Rica,

America/Panama,

America/Bogota,

America/Lima,

America/Santiago,

America/Argentina/Buenos_Aires,

America/Sao_Paulo,

America/Montevideo,

America/Puerto_Rico,

Europe/London,

Europe/Dublin,

Europe/Lisbon,

Europe/Madrid,

Europe/Paris,

Europe/Brussels,

Europe/Amsterdam,

Europe/Luxembourg,

Europe/Berlin,

Europe/Zurich,

Europe/Vienna,

Europe/Rome,

Europe/Copenhagen,

Europe/Stockholm,

Europe/Oslo,

Europe/Prague,

Europe/Budapest,

Europe/Warsaw,

Europe/Helsinki,

Europe/Tallinn,

Europe/Riga,

Europe/Vilnius,

Europe/Belgrade,

Europe/Tirane,

Europe/Sofia,

Europe/Athens,

Europe/Bucharest,

Europe/Kyiv,

Europe/Chisinau,

Europe/Istanbul,

Europe/Kaliningrad,

Europe/Moscow,

Europe/Samara,

Africa/Casablanca,

Africa/Algiers,

Africa/Tunis,

Africa/Cairo,

Africa/Tripoli,

Africa/Lagos,

Africa/Accra,

Africa/Dakar,

Africa/Abidjan,

Africa/Nairobi,

Africa/Dar_es_Salaam,

Africa/Kampala,

Africa/Johannesburg,

Africa/Maputo,

Africa/Windhoek,

Asia/Dubai,

Asia/Riyadh,

Asia/Qatar,

Asia/Kuwait,

Asia/Bahrain,

Asia/Muscat,

Asia/Baghdad,

Asia/Amman,

Asia/Beirut,

Asia/Jerusalem,

Asia/Baku,

Asia/Tbilisi,

Asia/Yerevan,

Asia/Almaty,

Asia/Tashkent,

Asia/Karachi,

Asia/Kolkata,

Asia/Dhaka,

Asia/Colombo,

Asia/Kathmandu,

Asia/Bangkok,

Asia/Ho_Chi_Minh,

Asia/Singapore,

Asia/Kuala_Lumpur,

Asia/Jakarta,

Asia/Manila,

Asia/Shanghai,

Asia/Hong_Kong,

Asia/Taipei,

Asia/Seoul,

Asia/Tokyo,

Australia/Sydney,

Australia/Melbourne,

Australia/Brisbane,

Australia/Adelaide,

Australia/Perth,

Australia/Darwin,

Australia/Hobart,

Pacific/Auckland

dot_id

string | null

DOT identifier associated with the user/carrier.

phone_country_code

string | null

Phone country code in '+' format, e.g., '+1'.

hos_tracking_mode

HosTrackingMode · object

Normalized HOS tracking configuration.

Show child attributes

hos_compliance_type

enum<string> | null

Driver HOS compliance classification: exempt or non-exempt.

Available options:

exempt,

non_exempt

hos_tracking_method

enum<string> | null

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

Available options:

manual,

automatic

Response

The user was created successfully.

Resource operation model

partner_id

string<uuid>

required

The ID of the partner that created the operation.

connection_id

string<uuid>

required

The ID of the connection

resource

enum<string>

required

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

Available options:

asset,

driver_association,

driver_vehicle_association,

driver_event_log,

driver_safety_event,

dvir_log,

dvir_log_defect,

engine_log,

engine_status,

fuel_transaction,

fleet_info,

hos_availability,

hos_daily_snapshot,

hos_event,

hos_event_annotation,

hos_event_attachment,

hos_violation,

ifta_summary,

location_segment,

message,

group_message,

user,

vehicle,

vehicle_location,

vehicle_sensor,

vehicle_region_segment,

trailer,

trailer_association,

trailer_vehicle_association,

trailer_location,

trailer_status,

workflow

operation_type

enum<string>

required

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

Available options:

create,

update

payload

Operation Payload · object

required

The payload of the operation, containing the resource attributes to be created or updated.

string<uuid>

Unique identifier for the resource operation.

created_at

string<date-time>

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

updated_at

string<date-time>

The datetime the record was last modified in Catena Telematics.

deleted_at

string<date-time> | null

The datetime the record was logically deleted from Catena Telematics.

resource_id

string<uuid> | null

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

source_id

string | null

The unique identifier of the resource in the source system. Required for update operations.

status

enum<string>

default:pending

The status of the operation

Available options:

pending,

success,

failed

logs

ResourceOperationLog · object[]

Log entries for each attempt to execute this operation.

Show child attributes