PATCH /company-locations

patch

https://integrations.mavenmachines.com/company-locations

Updates a company location record in the Maven system.
A companyLocationId or externalCompanyLocationId must be supplied.
If both a supplied, Maven will first search by companyLocationId.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

companyLocationId

number

Unique identifier for location

externalCompanyLocationId

string

Unique external identifier for location

Body Params

name

string

Name of location

address1

string

Street address of location

address2

string

Secondary address line of location

city

string

City of location

state

string

State of location

zip

string

Zip/postal code of location

country

string

Country of location

latitude

number

Latitude - double - 5 decimal places (between -90 and 90)

longitude

number

Longitude - double - 5 decimal places (between -180 and 180)

notes

string

Free-form notes about location

attributes

object

key/value object of custom user defined fields. Max 10 fields allowed.

locationTagNames

array

Array of strings. Location tags are used to add properties to the location.

locationTagNames

locationCategoryNames

array

Array of strings. Location categories are used to identify and separate company locations.

locationCategoryNames

terminalCode

string

The Terminal Code of the terminal linked to the location.

geofences

array of objects

Geofences data object

geofences

availability

array of objects

Availability data object

availability

Response

200A successful API response for company location record update