Creates new location

  • 1 minute(s) read
Prev Next
Post
/network/locations

Required permissions: READ_CUSTOMER, READ_LOCATION, WRITE_LOCATION.

Security
HTTP
Type bearer
Header parameters
X-Servitly-Tenant
stringRequired

The name of the target tenant (e.g. acme).

Body parameters

The details of location being created.

Expand All
object
name
string

The location name.

country
string

The country the location belongs to.

timezone
string

The timezone used for date/times localization (e.g. Europe/Rome).

gpsPosition
string

The GPS coordinates associated with this location.

properties
object (Properties)

The set of properties providing additional details to the parent object.

Example{ "foo": "abc", "bar": "123" }
property*
string additionalProperties
customerId
string

The customer identifier.

customer
object

The location identifier (required only for creation).

id
string
Example1234abcd
Responses
201

Successful created.

Expand All
object
id
string

The location object identifier.

name
string

The location name.

country
string

The country the location belongs to.

timezone
string

The timezone used for date/times localization (e.g. Europe/Rome).

gpsPosition
string

The GPS coordinates associated with this location.

properties
object (Properties)

The set of properties providing additional details to the parent object.

Example{ "foo": "abc", "bar": "123" }
property*
string additionalProperties
customerId
string

The customer identifier.

400

Request data not valid.

object
message
string

The error response.

ExampleBad request
401

User not authenticated.

object
message
string

The error response.

ExampleUser not authenticated
403

User not authorized.

object
message
string

The error response.

ExampleUser not authorized
429

API call rate limit exeeded.

object
message
string

The error response.

ExampleAPI call rate limit exeeded
500

Internal server error.

object
message
string

The error response.

ExampleInternal Server Error