GuidesAPI Reference
Log In
API Reference

Update Customer

Use to update a customer's details.

NOTE: Use a customer object for the body parameter, see JSON examples below.

Body Params
int32
required

The Bringg ID of the customer. Must use this field or external_id.

string
required

Your system's ID for the customer. Must use either this field or id.

string

The address of this customer. Must be geolocated in Google Maps. The maximum length is 255 characters.

string

The address second line of this customer, if needed. For example, "First floor" or "Apartment 1".

boolean

Indicates whether this customer can login. The values are: false or 0 - customer cannot login, true or 1 - customer can login.

boolean

Indicates whether this customer allows email sharing. The values are: false or 0 - customer does not allow email sharing, true or 1 - customer allows email sharing.

boolean

Indicates whether this customer allows SMS sharing.The values are: false or 0 - customer does not allow SMS sharing, true or 1 - customer allows SMS sharing.

string

This customer's borough. This can also be used for any neighborhood or zone.

string

This customer's city.

string

The confirmation code sent to this customer's phone for login verification.

string

This customer's district.

string

The email address of this customer. The default value is an empty string.

string

The house number of this customer.

string

The URL of an image associated with this customer.

int32

In any order, this indicates the type of location of the given waypoint. Options include: Customer address = 0, Warehouse = 1, Store location = 2, Locker = 3, Fulfillment center = 5

string

The language setting from this customer's app. This is a 2-letter code, for example "en" for English or "fr" for French. Note: This may be different than the company's default language.

float

The latitude of this customer's address.

float

The longitude of this customer's address.

string

The name of this customer. The maximum length is 255 letters.

boolean

Indicates whether there is a loading/unloading zone at the destination.

string

The phone number of this customer.

int32

Gives priority between customers when using Route Optimization or AutoDispatch. null is the lowest rank, 1 is the highest rank (for example rank null < rank 3 < rank 2 < rank 1). 0 in not accepted.

string

This customer's state.

string

This customer's street.

string

An array of the team id's for the teams responsible for delivery to this customer.

string

This customer's ZIP Code. The default value is null.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
LoadingLoading…
Response
Choose an example:
application/json