API Reference

Update an existing department

put
https://api.gupy.io/os/v1/departments/

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.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Department external code

Body Params
string
required
length ≤ 300

Department name

string
length ≤ 900

Department description

string
enum

Department type

Allowed:
string | null

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

Responses
200

Department updated successfully

400

Bad Request - Validation errors

404

Department not found

409

Conflict - Cost center not found

Updated 2 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago

Did this page help you?