GuidesAPI ReferenceDiscussions
API Reference

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Location record to create

string
required
length ≤ 50

Location's name

string
length ≤ 100

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

string
length ≤ 100

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

string
length ≤ 100

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

string
length ≤ 50

City, town, or suburb of the location's address.

string
length ≤ 100

Country of the location's address. Country names are sanitized through the RegionsanitiseCountryName function.

string
length ≤ 100

Postal code or ZIP code of the location's address. Format varies by country.

string
length ≤ 100

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

string
required

Address State

float

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

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

Updated 3 days ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 days ago