Update an existing dispatch location

Purpose: Use this API to update an existing dispatch location of your company.

Dispatch locations are categorised into two types:

• Geocoded Dispatch Locations: Geocoded dispatch locations have specific geographic data assigned to them, including latitude, longitude, arrive radius, and depart radius. These values are crucial as they enable the system to accurately pinpoint the dispatch location on a map. The latitude and longitude coordinates define the exact position, while the arrive and depart radii set boundaries around the location.
• Non-Geocoded Dispatch Locations: Non-geocoded dispatch locations, on the other hand, do not have latitude, longitude, arrive radius, or depart radius values assigned to them. These locations are typically defined by address information such as street, city, state, and ZIP code, but lack the precise geographic data needed for certain automated features.

📘

NOTE

In order to update the existing dispatch location, you must enter either one of the values in the Query Parameters section:

• ID
• Vendor ID

Refer to the Query Parameters section for more info.

Response Parameters

dispatch_location

• Type: Object
• Description: Details of the dispatch location.

id

• Type: Integer
• Description: Unique identifier for the dispatch location.

vendor_id

• Type: String
• Description: Vendor identifier associated with the dispatch location.

lat

• Type: Integer
• Description: Latitude of the dispatch location.

lon

• Type: Integer
• Description: Longitude of the dispatch location.

name

• Type: String
• Description: Name of the dispatch location.

address1

• Type: String
• Description: Primary address line of the dispatch location.

address2

• Type: String
• Description: Secondary address line of the dispatch location.

city

• Type: String
• Description: City where the dispatch location is situated.

state

• Type: String
• Description: State where the dispatch location is situated.

zip

• Type: String
• Description: ZIP code of the dispatch location.

country

• Type: String
• Description: Country where the dispatch location is located.

arrive_radius

• Type: Integer
• Description: Arrival radius in meters for the dispatch location.

depart_radius

• Type: Integer
• Description: Departure radius in meters for the dispatch location.

phone

• Type: String
• Description: Phone number associated with the dispatch location.