Skip to main content
POST
/
api
/
departments
Create a new department
curl --request POST \
  --url https://your-instance.example.com/api/departments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "managerIds": [
    "<string>"
  ],
  "userIds": [
    "<string>"
  ]
}
'
{
  "department": {
    "_id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "organizationId": "<string>",
    "managerIds": [
      {
        "_id": "<string>",
        "fullName": "<string>",
        "email": "<string>",
        "accessRole": "<string>",
        "departmentId": "<string>",
        "phoneNumber": "<string>",
        "designation": "<string>"
      }
    ],
    "userIds": [
      {
        "_id": "<string>",
        "fullName": "<string>",
        "email": "<string>",
        "accessRole": "<string>",
        "departmentId": "<string>",
        "phoneNumber": "<string>",
        "designation": "<string>"
      }
    ],
    "createdBy": {},
    "updatedBy": {},
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
name
string
required
​
description
string
​
managerIds
string[]
​
userIds
string[]

Response

Department created

​
department
object