Update org department

PATCH /orgs/departments/{departmentId}

Path parameters

departmentId string Required

The department's unique document ID, i.e. org.departments[]._id.

application/json

Body Required

customId string

A custom identifier for internal reference by your system (not used by missionX).
title string

The name of the department.
description string

An optional description for the department.

Responses

200 application/json

Successful response
Hide response attributes Show response attributes object
- _id string(ObjectId)
  
  The unique document ID.
- customId string
  
  A custom identifier for internal reference by your system (not used by missionX).
- title string
  
  The name of the department.
- description string
  
  An optional description for the department.
400 application/json

Bad Request
Hide response attributes Show response attributes object
- message string
  
  An error message.
- code string
  
  An error code to handle specific error responses.
- data object
  
  Optionally, additional data to help handle the error.
  
  Hide data attributes Show data attributes object
  
  Additional properties
  
  key null
500 application/json

Internal Server Error
Hide response attributes Show response attributes object
- message string
  
  An error message.
- code string
  
  An error code to handle specific error responses.
- data object
  
  Optionally, additional data to help handle the error.
  
  Hide data attributes Show data attributes object
  
  Additional properties
  
  key null

PATCH /orgs/departments/{departmentId}

curl \
 -X PATCH https://open.api.missionx.ai/v1/orgs/departments/{departmentId} \
 -H "Content-Type: application/json" \
 -d '{"customId":"string","title":"string","description":"string"}'

Request examples

{
  "customId": "string",
  "title": "string",
  "description": "string"
}

Response examples (200)

{
  "_id": "string",
  "customId": "string",
  "title": "string",
  "description": "string"
}

Response examples (400)

{
  "message": "string",
  "code": "string",
  "data": {
    "key": null
  }
}

Response examples (500)

{
  "message": "string",
  "code": "string",
  "data": {
    "key": null
  }
}