Creates a Location.

post

https://api.hcssapps.com/setups/api/v2/locations

Create a new location in the provided products.
If Dispatcher or HeavyJob Desktop is Integrated, this process will be handled as a background task
For help with authorization, please visit https://developer.hcssapps.com/getting-started/request-tokens

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The location.

products

string

enum

A list of what products the Location should be visible in.

Allowed:

code

string

required

A code that represents this location.

address

string | null

The address.

businessUnit

string

required

The code of the business unit the location is in.

city

string | null

The city.

country

string | null

The country.

description

string | null

The description of the location.

endDate

date-time | null

The end date.

latitude

double | null

The latitude decimal value.

locationType

string

required

The code of the location's type.

longitude

double | null

The longitude decimal value.

startDate

date-time | null

The start date.

state

string | null

The state.

status

string

enum

Allowed:

zipCode

string | null

The zip code.

productData

object

Headers

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Responses

401

Unauthorized

403

Forbidden

Language

Credentials

OAuth2

Loading…

Response

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

application/json

201Created