Department Creation APIAPI Explorer

Introduction

API Introduction

Department Creation API enables you to create a new department.

API Version

API Version

Updated Time

Version Description

V1

2022.10.28

The API request frequency is increased from five times/second to 20 times/second. The API route is changed to POST corp/department/create.

V2

2023.08.01

A new response parameter called "seq" has been added. This parameter allows for sorting departments within their parent department.

API Calling

The API enables you to create a new department.

Request URL: https://api.jodoo.com/api/v5/corp/department/create

Request Rate: 20 times/second

Request Method: POST

Request Parameters:

Parameter

Required

Type

Description

name

Yes

String

The department name (32 characters at most)

parent_ no

No

Number

If the parent department ID parameter is not passed when you create a department, the system will automatically set the department as a sub-department of the root department.

dept_no

No

Number

When you create a department, if no department ID is provided, a unique department ID will be automatically generated by the system (with an upper limit of 9007199254740991)

Sample Request:

{
    "name": "Finance department",
    "parent_no": 1,
    "dept_no": 2
}

Responses:

Parameter

Type

Description

department

JSON

The information of the created department

dept_no

Number

Department number

name

String

Department name

parent_ no

Number

Parent department ID

type

Number

Department type

status

Number

Departmental status

seq

Number

Department sorting

Sample Response:

{
  "department": {
    "dept_no": 2,
    "name": "Finance department",
    "parent_no": 1,
    "type": 0,
    "status": 1
    "seq": 1
  }
}

Was this information helpful?
Yes
NoNo
Need more help? Contact support