Create a new location

Prev Next
Post
/v{version}/Locations

Write permission of the parent location is required. The name of the location must be unique within the children of the parent location.

Security
API Key: api_key
Header parameter nameX-ApiKey

Api Key

API Key: session_id
Header parameter nameX-Session-Id

Session Id

Path parameters
version
stringRequired

The requested API version

Body parameters

Request that contains information to create a new location

Expand All
object

Location details

Address
string

Address of the location

CategoryIds
Array of integer Required

List of category IDs of the location

integer (int32)
City
string

City of the location

Country
string

Country of the location

Email
string

Email address of the location

Fax
string

Fax number of the location

HolidayListIds
Array of integer Required

List of holiday list IDs of the location

integer (int32)
Name
string Required

Name of the location

ParentId
integer (int32) Required

Unique ID of the parent location

Minimum1
Maximum2147483647
Permissions
object Required

Dictionary of UserGroupId and PermissionSet

property*
object additionalProperties

A set containing multiple entries containing one user group and its available permissions

Read
boolean
Write
boolean
ReceiveMessage
boolean
PhoneNumber
string

Phone number of the location

ZipCode
string

ZIP code of the location

Responses
201

Returns the created location details.

Expand All
object

Location details

Address
string

Address of the location

CategoryIds
Array of integer

List of category IDs of the location

integer (int32)
City
string

City of the location

Country
string

Country of the location

Created
string (date-time)

Creation date in UTC

Email
string

Email address of the location

Fax
string

Fax number of the location

HolidayListIds
Array of integer

List of holiday list IDs of the location

integer (int32)
Id
integer (int32)

Unique ID of the location

Modified
string (date-time)

Modification date in UTC

Name
string

Name of the location

ParentId
integer (int32)

Unique ID of the parent location

Minimum1
Maximum2147483647
Permissions
object

Dictionary of UserGroupId and PermissionSet

property*
object additionalProperties

A set containing multiple entries containing one user group and its available permissions

Read
boolean
Write
boolean
ReceiveMessage
boolean
PhoneNumber
string

Phone number of the location

ZipCode
string

ZIP code of the location

400

Bad request

Expand All
object
ValidationErrors
object
property*
Array of string additionalProperties
string
401

Unauthorized

Expand All
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties
403

Access denied

Expand All
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties
500

Unexpected error

Expand All
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties