Change an existing location

  • Published on Jan 24, 2025
  • 1 minute(s) reading time
Prev Next
Put
/v{version}/Locations/{id}

Write permission of the parent location is required. The name of the location must be unique within the children of the parent location. Only an admin can change existing permissions.

Security
API Key
Header parameter nameX-ApiKey

Api Key

API Key
Header parameter nameX-Session-Id

Session Id

Path parameters
id
integer (int32) Required

Unique ID of the location

version
stringRequired

The requested API version

Default"1.18"
Body parameters

Change request that contains the new values for the 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.0
Maximum2147483647.0
Permissions
object Required

Dictionary of UserGroupId and PermissionSet

property*
object additionalProperties
Read
boolean
Write
boolean
ReceiveMessage
boolean
ZipCode
string

ZIP code of the location

Responses
200

OK

object
400

Bad request

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

Access denied

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

Location not found

500

Unexpected error

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