GOgomotive

Update a dispatch location

put/v1/dispatch_locations

Request

Query parameters

idinteger required

Specify the ID of the dispatch location for which you want to make an update.

vendor_idinteger required

Specify the ID of the vendor for which you are making an update.

Headers

X-Metric-Unitsboolean

Specify if you want to use the Metric units or the Imperial units. TRUE: Metric units. FALSE: Imperial Units

Request body

namestring

Specify the name of the location for which you want create a dispatch.

address1string

Specify the primary address of the location.

address2string

Specify the address line 2 for the location.

citystring

Enter the name of the city where the dispatch is located at.

statestring

Enter the name of the state of the dispatch location.

zipstring

Enter the ZIP code of the dispatch location.

countrystring

Enter the country where the dispatch location is existing.

latnumber float

Enter the latitude coordinates of the dispatch location.

lonnumber float

Enter the longitude coordinates of the dispatch location.

arrive_radiusinteger

Radius of area when arriving at a stop for auto detection. Value should be in meters if X-Metric-Units is not specified or true. Value should be in foot if X-Metric-Units is false.

depart_radiusinteger

Radius of area when departing from a stop for auto detection. Value should be in meters if X-Metric-Units is not specified or true. Value should be in foot if X-Metric-Units is false.

phonestring

Enter the phone number of the location.

Response

200

Example response

{
  "dispatch_location": {
    "id": 2,
    "vendor_id": "foo",
    "lat": 2,
    "lon": 3,
    "name": "Office",
    "address1": "350 Sansome St.",
    "address2": "San Francisco",
    "city": "San Francisco",
    "state": "CA",
    "zip": "94104",
    "country": "US",
    "arrive_radius": 200,
    "depart_radius": 200,
    "phone": "(650) 238-9293"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.