The user
object is included in the Create and Update User endpoints and is included in some webhook callbacks when referring to driver and dispatch events.
Request Data
Below is a list of parameters you can send as part of the user
object, for example, when sending the Create User request.
Read our Data Formatting article for more details about how different parameter types, such as datetime, are formatted and used in Bringg.
Parameter | Description |
---|---|
admin boolean | Indicates if the user has administrative privileges. |
dispatcher boolean | Indicates if the user is a dispatcher. |
company_id string | Bringg's ID for the group of users within a team. See Get Companies. |
company_external_id string | Your external system's ID for the group of users within a team. See Get Companies. |
crew_external_id string | Your external system's ID for the driver's delivery crew, used to coordinate meetups and floating helper tasks during planned routes. |
driver boolean | Indicates if the user is a driver. |
email string | The user's email. |
emergency_contact_name string | Name of emergency contact (for use with the Rapid SOS application). |
emergency_contact_phone string | Phone number of emergency contact (for use with the Rapid SOS application). |
external_id string | The unique identifier for the user in your external system. |
external_team_ids array of strings | An array of your external system's IDs for the teams to which the user belongs. |
home_address string | The address of the user's "home" base, usually a warehouse or store location. |
home_lat number | The latitude of the user's "home" base. |
home_lng number | The longitude of the user's "home" base. |
language string | The user's preferred language. |
name string | The user's name. |
phone string | The user's phone number. |
privilege_id integer | The ID of the dispatcher or driver's Privileges group, which associates a dispatcher user with a set of authorization flags. |
private_vehicle boolean | Indicates whether the driver uses their own vehicle to determine if mileage should be compensated. |
skills array of strings | Driver capabilities, such as installation . Bringg matches these skills with the required_skills parameter to automatically assign routes to the most suitable driver based on their capabilities. |
team_ids array of strings | The IDs of the teams to which the user belongs. |
user_type_external_id string | The driver user role ID in your external systems. Can be used instead of user_type_id . |
user_type_id integer | The ID of the user type within Bringg. |
Response & Webhook Data
Parameter | Description |
---|---|
* | Indicates whether the service completed successfully.
|
* | If an error occurred, a message indicating the error is included. |
* | If an error occurred, the return code is included. |
* | The access token for the user. |
* | The ID of the driver's current shift. |
* | The ID of the team the driver is currently assigned to. |
* | Indicates if the user has administrative privileges. |
* | |
* | The ID of the mobile app the user is using. |
* | Indicates whether the driver is located at their "home" base, usually a store or warehouse. |
* | The authentication token for the user. |
* | An object containing user privileges. |
* | The average rating the driver has received. |
* | The current battery level of the user's device. |
* | Indicates if the user is part of a beta program. |
* | Indicates whether this user's email is blocked. The values are:
|
* | |
* | Bringg's ID for the group of users within a team. See Get Companies . |
* | The name of the company. |
* | The confirmation code sent to this user's phone for login verification. |
* | The timestamp when the confirmation code allowing the new user to login was sent. |
* | |
* | The timestamp when the user was created. This is in UTC and the format is "%Y-%m-%dT%H:%M:%S%z". |
* | Bringg's ID for the driver's delivery crew, used to coordinate meetups and floating helper tasks during planned routes. |
* | The ID of the order the driver is actively fulfilling. |
* | The ID of the user's current unavailability status. |
* | The ID of the vehicle currently assigned to the user. |
* | |
* | The user's default activity. The values are:
|
* | |
* | The date and time this user was deleted, if the user was deleted. This is in UTC and is in the format is "%Y-%m-%dT%H:%M:%S%z". |
* | The model of the user's mobile device. |
* | Indicates if the user is a driver. |
* | |
* | Indicates whether this user is a Bringg driver. The values are:
|
* | The timestamp of the driver's current sign-in. This is in UTC and the format is "%Y-%m-%dT%H:%M:%S%z". |
* | The timestamp of the driver's last sign-in. This is in UTC and the format is "%Y-%m-%dT%H:%M:%S%z". |
* | The number of times the driver has signed in. |
* | The user's email. |
* | The hash of the user's email. |
* | Name of emergency contact (for use with the Rapid SOS application). |
* | Phone number of emergency contact (for use with the Rapid SOS application). |
* | The last known address of the user using approximation based on last or next delivery. |
* | The estimated time of leaving the last known order location (ETA plus time on site). This is in UTC and the format is "%Y-%m-%dT%H:%M:%S%z". |
* | The last known latitude of the user using approximation based on last or next delivery. |
* | The last known longitude of the user using approximation based on last or next delivery. |
* | The Id of the last known way point for the user using approximation based on last or next delivery. |
* | The estimated time of arrival to the driver's "home" base. |
* | Indicates whether the user belongs to an external carrier. |
* | The unique identifier for the user in your external system. |
* | |
* | |
* | If this user is assigned to an external fleet, this is the Id of that external fleet. |
* | The date and time of this user will be required to change passwords. This is in UTC and is in the format is "%Y-%m-%dT%H:%M:%S%z". |
* | The token for this user's required change of passwords. |
* | The address of the user's "home" base, usually a warehouse or store location. |
* | The latitude of the user's "home" base. |
* | The longitude of the user's "home" base. |
* | The unique identifier of the user. |
* | Indicates whether the user is in range of a known beacon.
|
* | The user's job description. |
* | The user's preferred language in the Bringg UI. This is a 2-letter code. For example, "en" for English or "fr" for French. This is only relevant for Dispatcher and Admin users who log into the Bringg dashboard. |
* | The timestamp when the user's logs were last requested. |
* | |
* | |
* | The timestamp of the driver's last sign-in. |
* | The latitude of the user's last reported location. |
* | The longitude of the user's last reported location. |
* | |
* | The ID of the merchant to which the user belongs. |
* | The saved settings for the driver's mobile app. |
* | The type of mobile device the user is using. |
* | The version of the mobile app the user is using. |
* | The user's name. |
* | The number of ratings the driver has received. |
* | The original phone number of this user, if the phone number was changed. |
* | The original Id of this user, if the Id was changed. |
* | The operating system version of the driver's mobile device. |
* | |
* | The hash of the user's password. |
* | The user's phone number. |
* | The hash of the user's phone number. |
* | Indicates whether the driver uses their own vehicle to determine if mileage should be compensated.
|
* | The ID of the dispatcher or driver's Privileges group, which associates a dispatcher user with a set of authorization flags. |
* | The URL of the user's profile image. |
* | The push token for the user's device. |
* | |
* | |
* | |
* | Driver capabilities, such as |
* | The user's status. The possible values are: Free, Assigned, Started, Checked-In, Late, Offline |
* | The sub status of the user. The maximum length is 255 characters. |
* | An array of Bringg IDs for the teams to which the user belongs. |
* | An array of your system's IDs for the teams to which the user belongs. |
* | The last date and time this user was updated. This is in UTC and the format is "%Y-%m-%dT%H:%M:%S%z". |
* | |
* | The ID of the user type within Bringg. |
* | The universal unique Id of this user. |
* | The ID of the vehicle associated with this user. |
* |