update a user

POST

/partners/users/{user_email}

Update a user's information. All the attributes are optional, only the posted attributes will be changed

"active" is where user is marked as removed, if acitve is false, user is accessible by email but not searchable and not in the users list.

A partner can not change the role of his own, but can assign fleet manager, group_manager, end_user role to a user.

Request

Path Params

user_email

string

required

Body Params multipart/form-data

last_name

string

required

Example:

first_name

string

required

Example:

roles

string

required

Example:

phone_number

string

required

Example:

alert_gsensor

string

required

Example:

alert_critical_gsensor

string

required

Example:

alert_speed

string

required

Example:

alert_sensor

string

required

Example:

alert_sd_error

string

required

Example:

alert_unclean_shutdown

string

required

Example:

alert_camera_failure

string

required

Example:

active

string

required

Example:

alert_dv_camera_failure

string

required

Example:

alert_high_temperature

string

required

Example:

speed_unit

string

required

Example:

aggr_notific_interval

string

required

Example:

alert_inactive_vehicles

string

required

Example:

alert_summary

string

required

Example:

flood_notification

string

required

Example:

reformat_reminder

string

required

Example:

alert_inactive_vehicles_time

string

required

Example:

recording_status_notifs

string

required

Example:

alert_camera_errors

string

required

Example:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://fleet.roscolive.com/api/v1.0/partners/users/' \
--form 'last_name="{{lastname_changed}}"' \
--form 'first_name="{{firstname_changed}}"' \
--form 'roles="{{group_manager or end_user}}"' \
--form 'phone_number="{{phone_changed}}"' \
--form 'alert_gsensor="{{true or false}}"' \
--form 'alert_critical_gsensor="{{true or false}}"' \
--form 'alert_speed="{{true or false}}"' \
--form 'alert_sensor="{{true or false}}"' \
--form 'alert_sd_error="{{true or false}}"' \
--form 'alert_unclean_shutdown="{{true or false}}"' \
--form 'alert_camera_failure="{{true or false}}"' \
--form 'active="{{true or false}}"' \
--form 'alert_dv_camera_failure="{{alert_dv_camera_failure}}"' \
--form 'alert_high_temperature="{{true or false}}"' \
--form 'speed_unit="{{mph or kph}}"' \
--form 'aggr_notific_interval="{{aggr_notific_interval}}"' \
--form 'alert_inactive_vehicles="{{true or false}}"' \
--form 'alert_summary="{{true or false}}"' \
--form 'flood_notification="{{true or false}}"' \
--form 'reformat_reminder="{{true or false}}"' \
--form 'alert_inactive_vehicles_time="{{1-5}}"' \
--form 'recording_status_notifs="{{true or false}}"' \
--form 'alert_camera_errors="{{true or false}}"'

Responses

🟢200valid update a user

application/json

Body

object {0}

Example

{
    "meta": {
        "code": 200
    },
    "response": {
        "user": [
            {
                "active": bool,
                "aggr_notific_interval": int,
                "alert_camera_failure": bool,
                "alert_critical_gsensor": bool,
                "alert_dv_camera_failure": bool,
                "alert_high_temperature": bool,
                "alert_inactive_vehicles": bool,
                "alert_inactive_vehicles_time": none,
                "alert_sd_error": bool,
                "alert_sensor": bool,
                "alert_speed": bool,
                "alert_summary": bool,
                "audit_notification": bool,
                "company_audit_log": none,
                "company_data": dict,
                "company_driver_recognition": "str",
                "company_id": int,
                "company_name": "str",
                "company_reformat_reminder": int,
                "company_token": "str",
                "company_type": "str",
                "confirmed_at": bool,
                "created_timestamp": "str",
                "data_usage_notification": bool,
                "data_usage_notification_vehicle_limit": "str",
                "email": "str",
                "eula_was_viewed": bool,
                "event_breakdown": bool,
                "first_name": "str",
                "flood_notification": bool,
                "groups": list,
                "harshaccel": none,
                "harshbraking": none,
                "has_registered_sms": bool,
                "high_speeding": none,
                "id": int,
                "installer_company_name": none,
                "is_fake": bool,
                "last_login": "str",
                "last_name": "str",
                "low_speeding": none,
                "mecp_cert": bool,
                "moderate_speeding": none,
                "partner_company_name": "str",
                "phone_number": "str",
                "recent_activity": "str",
                "recording_status_notifs": bool,
                "reformat_last_notifs": none,
                "reformat_reminder": bool,
                "release_viewed": "str",
                "roles": list,
                "rosco_product_owned": none,
                "settings": dict,
                "severe_speeding": none,
                "speed_unit": "str",
                "status": "str",
                "unidentified_drivers": bool,
                "work_submission_report": none
            }
        ]
    }
}

🟠404update a non existing user

🟠401Login Required

Modified at 2024-07-25 02:00:14

Get a user

remove a user