Edit Area

PATCH

areas

{id}

curl --request PATCH \
  --url https://api.roostedhr.com/api/1_12/areas/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "name": "Northeast Region"
}
'

{
  "id": "a1B2c",
  "name": "Northeast Region",
  "parent_id": "",
  "nlevel": 0,
  "protected": false
}

The API validates against circular references — an area cannot be set as its own parent (ARA-500). Only name and parent_id can be updated; the id is immutable.

Authorizations

X-API-KEY

string

header

required

Path Parameters

string

required

Unique area identifier.

Example:

"a1B2c"

Body

application/json

name

string

New display name for the area.

Maximum string length: 50

Example:

"Northeast Region"

parent_id

string

New parent area ID, or empty string to make top-level.

Example:

""

Response

string

Unique area identifier.

Example:

"a1B2c"

name

string

Display name of the area.

Example:

"Northeast"

parent_id

string

Parent area ID, or empty string if top-level.

Example:

""

nlevel

integer

Nesting depth (0 = top-level).

Example:

0

protected

boolean

Whether the area is system-protected.

Example:

false

Delete AreaPermanently deletes an area. Protected areas and areas with children cannot be deleted.

curl --request PATCH \
  --url https://api.roostedhr.com/api/1_12/areas/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "name": "Northeast Region"
}
'

{
  "id": "a1B2c",
  "name": "Northeast Region",
  "parent_id": "",
  "nlevel": 0,
  "protected": false
}

Overview

Announcements

Areas

Clients

Company

Configuration

Events

Locations

Payroll Groups

Rate Cards

Skillsets

Time Tracking

Wage Rules

Workers

Authorizations

Path Parameters

Body

Response