Skip to main content
PATCH
/
locations
/
{id}
Edit Location
curl --request PATCH \
  --url https://api.roostedhr.com/api/1_12/locations/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "location": "<string>",
  "address": "<string>",
  "city": "<string>",
  "zip": "<string>",
  "color": "<string>",
  "location_comments": "<string>",
  "timezone_id": 123,
  "default_clients_id": "<string>",
  "default_areas": [
    "<string>"
  ]
}
'
{
  "id": "<string>",
  "location": "<string>",
  "addy_street_number": "<string>",
  "addy_city": "<string>",
  "addy_zip": "<string>",
  "location_comments": "<string>",
  "default": 0,
  "saved": 0,
  "color": "#DC136C",
  "timezone": {
    "id": 123,
    "name": "<string>",
    "offset": "<string>"
  },
  "companies_payroll_rulesets_id": "<string>",
  "payroll_rule_display": "<string>",
  "latitude": "<string>",
  "longitude": "<string>",
  "default_clients_id": "<string>",
  "default_areas": [
    "<string>"
  ]
}
This is a partial update endpoint — only include the fields you want to change. Omitted fields remain unchanged.

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
id
string
required

Location ID

Body

application/json

Fields to update

​
location
string

Location name

Maximum string length: 150
​
address
string

Street address

Maximum string length: 150
​
city
string

City

Maximum string length: 75
​
zip
string

ZIP/postal code

Maximum string length: 10
​
color
string

Hex color code

Maximum string length: 7
​
location_comments
string

Additional comments

Maximum string length: 65535
​
timezone_id
integer

Timezone identifier

Required range: x <= 999
​
default_clients_id
string

Default client hashed ID

Maximum string length: 5
​
default_areas
string[]

Default area IDs

Response

OK

​
id
string

Location identifier

​
location
string

Location name

​
addy_street_number
string

Street address

​
addy_city
string

City

​
addy_zip
string

ZIP/postal code

​
location_comments
string | null

Additional comments

​
default
integer | null

Whether this is the default location (0 or 1)

Required range: 0 <= x <= 1
​
saved
integer | null

Whether the location is saved (0 or 1)

Required range: 0 <= x <= 1
​
color
string | null

Hex color code

Example:

"#DC136C"

​
timezone
object

Location timezone

​
companies_payroll_rulesets_id
string | null

Associated payroll ruleset ID

​
payroll_rule_display
string | null

Payroll rule display name

​
latitude
string | null

GPS latitude coordinate

​
longitude
string | null

GPS longitude coordinate

​
default_clients_id
string | null

Default client hashed ID

​
default_areas
string[]

Default area IDs