Create a Location

Create a location within the specified account.

Body Params
string
required
length ≥ 1

The name of the location.

address
object
required

The full address of the location.

coordinates
object
required

Coordinates of the location.

radius
object

The radius of the location geofence. Minimum value is 50m, maximum is 400km. Tolerance less than 400m will require GPS and frequent transmit intervals for accurate readings.

string
enum
boolean
boolean
labels
array of objects | null
labels
alertPresetIds
array of int32s | null
alertPresetIds
collaborators
array of objects | null

A list of users you would like to collaborate with and their access level for any shipment using the specified location.

collaborators
Headers
int32
required

ID of the account the request will be made in.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

400

Unable to create the location. See response message for details.

401

Unauthorized

Language
Response
Click Try It! to start a request and see the response here!