Skip to main content
POST
/
locations
Create Location
curl --request POST \
  --url https://api.roostedhr.com/api/1_12/locations \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "location": "<string>",
  "address": "<string>",
  "city": "<string>",
  "zip": "<string>",
  "timezone_id": 499,
  "color": "<string>",
  "location_comments": "<string>",
  "default_clients_id": "<string>",
  "default_areas": [
    "<string>"
  ]
}
'
{
  "id": 123,
  "location": "<string>",
  "addy_street": "<string>",
  "addy_city": "<string>",
  "addy_zip": "<string>",
  "location_comments": "<string>",
  "default": 0,
  "saved": 0,
  "color": "<string>",
  "timezone_id": "<string>",
  "timezone_display": "<string>",
  "companies_payroll_rulesets_id": "<string>",
  "payroll_rule_display": "<string>",
  "latitude": "<string>",
  "longitude": "<string>",
  "default_clients_id": "<string>",
  "default_areas": [
    "<string>"
  ]
}

Authorizations

X-API-KEY
string
header
required

Body

application/json

Location Request Body

location
string
required
Required string length: 1 - 150
address
string
required
Required string length: 1 - 150
city
string
required
Required string length: 1 - 75
zip
string
required
Required string length: 1 - 10
timezone_id
integer
required
Required range: 0 <= x <= 999
color
string
Required string length: 2 - 7
location_comments
string
Maximum string length: 65535
default_clients_id
string
Maximum string length: 5
default_areas
string[]

Response

OK

id
integer
location
string
addy_street
string
addy_city
string
addy_zip
string
location_comments
string | null
default
integer | null
Required range: 0 <= x <= 1
saved
integer
Required range: 0 <= x <= 1
color
string
timezone_id
string
timezone_display
string
companies_payroll_rulesets_id
string | null
payroll_rule_display
string | null
latitude
string
longitude
string
default_clients_id
string
default_areas
string[]