Sign in
Department
Department

Update an existing department

Updates the provided department fields.

Business Rules:

  • name: Required. Maximum 300 characters.
  • description: Optional. Maximum 900 characters.
  • type: Optional. Must be one of: DEPARTMENT, SECTOR, SECTIONS.
  • costCenterCode: Optional. If provided, the cost center must exist. Set to null to remove cost center.
  • externalCode: Not editable in this endpoint.
put/os/v1/departments/{externalCode}

Path parameters

externalCodestring required

Department external code

Request body

namestring required

Department name

descriptionstring

Department description

type'DEPARTMENT' | 'SECTOR' | 'SECTIONS'

Department type

costCenterCodestring nullable

Cost center external code. Set to null to remove cost center.

Example request

{
  "name": "Engineering Department",
  "description": "Department responsible for software development",
  "type": "DEPARTMENT",
  "costCenterCode": "CC_008"
}

Response

Department updated successfully

Changes

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