GuidesAPI Reference
Log In
API Reference

Update Team

post
https://developer-api.bringg.com/services/j457d4jso//

Update the details of a team using its Bringg ID or your system's ID (external_id).

Response (Output) Params
ParameterDescription
*success**
boolean		Indicates whether the service completed successfully.
  • false* - the service failed.
  • true* - the service succeeded
*message**
string		If an error occurred, a message indicating the error is included.
*rc**
integer		If an error occurred, the return code is included.
*allow_access_to_all_open_tasks**
boolean

Indicates whether drivers receive unassigned tasks.

false - the drivers do not receive unassigned tasks.
true - the drivers do receive unassigned tasks.

*address**
string		The first line of the address associated with the team.
*address_second_line**
string		The second line of the address associated with the team. e.g. "1st floor", "Apartment 5a".
*beacon_ids**
array of strings		An array of beacon IDs associated with the team.
*city**
string		The city where the team is located.
*contact_phone**
string		The contact phone number associated with this team.
*country_code**
string		The two-letter ISO country code of the team’s location.
*created_at**
datetime		The timestamp when the user was created. This is in UTC and the format is "%Y-%m-%dT%H:%M:%S%z".
*default_customer_id**
int64		The default customer ID for the team.
*default_task_configuration_id**
int64
*default_user_id**
int64		The default user (driver) ID for the team.
*delete_at**
datetime		The timestamp when the team was deleted.
*description**
string		Additional details about the team.
*distance_pay_per_km**
float		The cost per kilometer for the team.
*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		Your system's ID for the team.
*extra**
object		Internal use.
*extras**
object		Internal use.
*franchisee_id**
int64		The Bringg ID for the related franchisee.
*geohash**
string		The geohash (public domain geocoding system hash) of this team.
*home_area**
object		An object containing the home area for this team.
*id**
int64		The unique identifier of the team.
*lat**
float		The geoposition latitude of the team's address.
*lng**
float		The geoposition longitude of the team's address.
*merchant_id**
int32		The ID of the merchant to which the team belongs.
*name**
string		The name of the team, such as a store or area.
*parent_team_id**
int64		The ID of the parent team associated with this team.
*printer_type**
string		The type of printer used to print receipts. The values are:
3"
A4
*required_coc_type**
string		The required chain of custody type. The values include:
  • 0* - weak
  • 1* - strong
  • 2* - none
  • 3* - unload
*service_boroughs**
array of strings		An array of boroughs serviced by the team.
*service_cities**
array of strings		An array of cities serviced by the team.
*service_zipcodes**
array of strings		An array of ZIP codes serviced by the team.
*state**
string		The state where the team is located.
*street**
string		The street where the team is located.
*task_invoice_template_name**
string
*team_type**
string
*time_zone**
string		The time zone of the team.
*updated_at**
datetime		The last date and time this team was updated. This is in UTC and the format is "%Y-%m-%dT%H:%M:%S%z".
*web_site**
string		The website URL associated with the team.
*zipcode**
string		The ZIP code of the team's location.
Body Params
int32
required

The Bringg ID of the team to update. Required if not using external_id.

string
required

Your system's ID of the team to update. Required if not using id.

string

The name of the team to update.

string

The address of the team to update.

string

The second line of the address associated with the team.

string

The city where the team is located.

string

The state where the team is located.

string

The ZIP Code of the team to update.

string

The two-letter ISO country code of the team’s location.

double

The geoposition latitude of the new team.

double

The geoposition longitude of the new team.

string

The time zone of the team to update.

string

The description of the team to update.

string

The contact phone number associated with the team to update.

service_boroughs
array of strings

An array of boroughs serviced by the team.

service_boroughs
service_cities
array of strings

An array of cities serviced by the team.

service_cities
service_zipcodes
array of strings

An array of ZIP codes serviced by the team.

service_zipcodes
double

The cost per kilometer for the team.

string

Name of emergency contact (for use with the Rapid SOS application).

string

Phone number of emergency contact (for use with the Rapid SOS application).

int32

The Bringg ID for the related Franchisee

string

The IDs of beacons associated with the team.

string

The type of printer used by this team.

team_configuration
object

This will create a Team Configuration associated with this Team.

json

An object containing geofence details for the team, including fields for lat and lng for each polygon point.

string

The website URL associated with the team.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 2 months ago

Language
LoadingLoading…
Response
Choose an example:
application/json

Updated about 2 months ago