Update Customer

post

https://developer-api.bringg.com/services/i58jfu44/{service_uuid1}/{service_uuid2}

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.

external_id

string

required

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

name

string

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

address

string

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

address_second_line

string

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

city

string

This customer's city.

state

string

This customer's state.

zipcode

string

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

string

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

allow_sending_email

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.

phone

string

The phone number of this customer.

allow_sending_sms

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.

lat

double

The latitude of this customer's address.

lng

double

The longitude of this customer's address.

kind

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

language

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.

district

string

This customer's district.

borough

string

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

confirmation_code

string

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

allow_login

boolean

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

house_number

string

The house number of this customer.

image

string

The URL of an image associated with this customer.

has_parking_area

boolean

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

rank

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.

street

string

This customer's street.

team_ids

string

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

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200200

400400