Create a new Location

post

https://api.servicem8.com/api_1.0/location.json

OAuth Scope

This endpoint requires the following OAuth scope manage_locations.

Record UUID

UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the x-record-uuid response header.

Body Params

Location record to create

name

string

required

length ≤ 50

Location's name

line1

string

length ≤ 100

First line of the location's address. Contains the street number and street name.

line2

string

length ≤ 100

Second line of the location's address. Used for additional address information such as building/suite numbers or street details.

line3

string

length ≤ 100

Third line of the location's address. Used for additional address details when line1 and line2 are not sufficient.

city

string

length ≤ 50

Email Address

country

string

length ≤ 100

Email Address

post_code

string

length ≤ 100

Email Address

phone_1

string

length ≤ 100

Primary contact phone number for the location. Can include formatting characters.

state

string

length ≤ 400

Address State

lng

float

Longitude coordinate of the location in decimal degrees format. Used for geolocation and distance calculations. Expected range is between -180 and 180 degrees.

lat

float

Latitude coordinate of the location in decimal degrees format. Used for geolocation and distance calculations. Expected range is between -90 and 90 degrees.

uuid

Unique identifier for this record

Responses

Language

Credentials

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

400Bad Request - The request is malformed or contains invalid parameters

401Unauthorized - Authentication credentials are missing or invalid

403Forbidden - You don't have permission to create this resource

429Too Many Requests - You have exceeded the rate limit

500Internal Server Error - An unexpected error occurred on the server