DEdeputy
Area Profile

Update an existing area

Update an existing area.

put/management/v2/areas/{id}

Request

  • Base URL
    https://your-subdomain.deputy.deputy.com/api
  • URL
    https://your-subdomain.deputy.deputy.com/api/management/v2/areas/{id}
  • Auth
    API key in header OAuth

Path parameters

idstring required

Request body

idinteger
namestring
locationIdinteger
parentIdinteger
workTypestring
isActiveboolean
exportCodestring
addressIdinteger
contactIdinteger
rosterSortOrderinteger
isOnRosterboolean
colorstring
areaType'DEFAULT_AREA' | 'AREA_WITH_GEO'
createdByIdinteger
createdAtstring date-time
modifiedAtstring date-time

Response

A successful response.

successboolean

Changes

No recorded changes to this operation across all 1 revision of this API.