{
  "openapi" : "3.1.0",
  "info" : {
    "title" : "Department",
    "version" : "1.0.0",
    "description" : "Departments are the organizational divisions configured in your help desk based on the business function performed by each division, such as marketing, sales, finance, and admin."
  },
  "paths" : {
    "/api/v1/departments/{departmentId}/associateAgents" : {
      "post" : {
        "tags" : [ "Department" ],
        "summary" : "Associate Agents to Department",
        "description" : "Associates agents to a department.",
        "operationId" : "associateAgentsToDepartment",
        "x-mcp-group" : [ "Departments" ],
        "parameters" : [ {
          "name" : "departmentId",
          "in" : "path",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : [ "string", "integer" ],
            "format" : "int64",
            "pattern" : "([0-9]+)"
          },
          "description" : "Unique ID of the department"
        }, {
          "$ref" : "./Common.json#/components/parameters/orgId"
        } ],
        "requestBody" : {
          "$ref" : "#/components/requestBodies/associateAgents_agentIdsArray"
        },
        "responses" : {
          "422" : {
            "$ref" : "./Common.json#/components/responses/invalidDataErrorResponse"
          },
          "204" : {
            "$ref" : "./Common.json#/components/responses/emptyResponse"
          }
        },
        "security" : [ {
          "iam-oauth2-schema" : [ "Desk.permissions.UPDATE" ]
        }, {
          "deprecated-iam-oauth2-schema" : [ "Desk.basic.UPDATE", "Desk.settings.UPDATE" ]
        } ]
      }
    },
    "/api/v1/departments/{departmentId}" : {
      "get" : {
        "tags" : [ "Department" ],
        "summary" : "Get Department",
        "description" : "Retrieves the details of a department from the help desk.",
        "operationId" : "getDepartment",
        "x-mcp-group" : [ "Departments" ],
        "parameters" : [ {
          "name" : "departmentId",
          "in" : "path",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : [ "string", "integer" ],
            "format" : "int64",
            "pattern" : "([0-9]+)"
          },
          "description" : "Unique ID of the department"
        }, {
          "$ref" : "./Common.json#/components/parameters/orgId"
        } ],
        "responses" : {
          "200" : {
            "$ref" : "#/components/responses/getDepartmentResponse"
          }
        },
        "security" : [ {
          "iam-oauth2-schema" : [ "Desk.basic.READ", "Desk.departments.READ" ]
        }, {
          "deprecated-iam-oauth2-schema" : [ "Desk.settings.READ" ]
        } ]
      },
      "patch" : {
        "tags" : [ "Department" ],
        "summary" : "Update Department",
        "description" : "Updates the details of an existing department.",
        "operationId" : "updateDepartment",
        "x-mcp-group" : [ "Departments" ],
        "parameters" : [ {
          "name" : "departmentId",
          "in" : "path",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : [ "string", "integer" ],
            "format" : "int64",
            "pattern" : "([0-9]+)"
          },
          "description" : "Unique ID of the department"
        }, {
          "$ref" : "./Common.json#/components/parameters/orgId"
        } ],
        "requestBody" : {
          "$ref" : "#/components/requestBodies/updateDepartmentJson"
        },
        "responses" : {
          "200" : {
            "$ref" : "#/components/responses/getDepartmentResponse"
          },
          "422" : {
            "$ref" : "./Common.json#/components/responses/invalidDataErrorResponse"
          }
        },
        "security" : [ {
          "iam-oauth2-schema" : [ "Desk.departments.UPDATE" ]
        }, {
          "deprecated-iam-oauth2-schema" : [ "Desk.basic.UPDATE", "Desk.settings.UPDATE" ]
        } ]
      }
    },
    "/api/v1/departments/{departmentId}/logo" : {
      "get" : {
        "tags" : [ "Department" ],
        "summary" : "Get Department Logo",
        "description" : "Retrieves the logo set for a department.",
        "operationId" : "getDepartmentLogo",
        "x-mcp-group" : [ "Departments" ],
        "parameters" : [ {
          "name" : "fileSize",
          "in" : "query",
          "description" : "Size of the image file to download <p><b>  Possible values:</b> THUMBNAIL, ACTUAL</p>",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : [ "string" ],
            "enum" : [ "ACTUAL", "THUMBNAIL" ]
          }
        }, {
          "name" : "departmentId",
          "in" : "path",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : [ "string", "integer" ],
            "format" : "int64",
            "pattern" : "([0-9]+)"
          },
          "description" : "Unique ID of the department"
        }, {
          "$ref" : "./Common.json#/components/parameters/orgId"
        } ],
        "responses" : {
          "200" : {
            "$ref" : "./Common.json#/components/responses/fileResponse"
          }
        },
        "security" : [ {
          "iam-oauth2-schema" : [ "Desk.basic.READ", "Desk.departments.READ" ]
        }, {
          "deprecated-iam-oauth2-schema" : [ "Desk.settings.READ" ]
        } ]
      },
      "post" : {
        "tags" : [ "Department" ],
        "summary" : "Update Department Logo",
        "description" : "Updates the logo set for a department.",
        "operationId" : "updateDepartmentLogo",
        "x-mcp-group" : [ "Departments" ],
        "parameters" : [ {
          "name" : "departmentId",
          "in" : "path",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : [ "string", "integer" ],
            "format" : "int64",
            "pattern" : "([0-9]+)"
          },
          "description" : "Unique ID of the department"
        }, {
          "$ref" : "./Common.json#/components/parameters/orgId"
        } ],
        "requestBody" : {
          "content" : {
            "multipart/form-data" : {
              "schema" : {
                "type" : [ "object" ],
                "properties" : {
                  "departmentLogo" : {
                    "type" : [ "string" ],
                    "format" : "binary",
                    "description" : "Image file of the logo  <p> Note: </p> - Maximum file size allowed is 2 MB   - Maximum number of files allowed is one   - Allowed extensions are jpg, png, gif, and jpeg"
                  }
                },
                "required" : [ "departmentLogo" ],
                "additionalProperties" : false
              }
            }
          }
        },
        "responses" : {
          "422" : {
            "$ref" : "./Common.json#/components/responses/multipleUnprocessEntityResponse"
          },
          "204" : {
            "$ref" : "./Common.json#/components/responses/emptyResponse"
          }
        },
        "security" : [ {
          "iam-oauth2-schema" : [ "Desk.departments.UPDATE" ]
        }, {
          "deprecated-iam-oauth2-schema" : [ "Desk.basic.UPDATE", "Desk.settings.UPDATE" ]
        } ]
      },
      "delete" : {
        "tags" : [ "Department" ],
        "summary" : "Delete Department Logo",
        "description" : "Deletes the logo set for a department.",
        "operationId" : "deleteDepartmentLogo",
        "x-mcp-group" : [ "Departments" ],
        "parameters" : [ {
          "name" : "departmentId",
          "in" : "path",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : [ "string", "integer" ],
            "format" : "int64",
            "pattern" : "([0-9]+)"
          },
          "description" : "Unique ID of the department"
        }, {
          "$ref" : "./Common.json#/components/parameters/orgId"
        } ],
        "responses" : {
          "204" : {
            "$ref" : "./Common.json#/components/responses/emptyResponse"
          }
        },
        "security" : [ {
          "iam-oauth2-schema" : [ "Desk.departments.UPDATE" ]
        }, {
          "deprecated-iam-oauth2-schema" : [ "Desk.basic.UPDATE", "Desk.settings.UPDATE" ]
        } ]
      }
    },
    "/api/v1/departments/{departmentId}/enable" : {
      "post" : {
        "tags" : [ "Department" ],
        "summary" : "Enable Department",
        "description" : "Enables a department in the help desk portal.",
        "operationId" : "enableDepartment",
        "x-mcp-group" : [ "Departments" ],
        "parameters" : [ {
          "name" : "departmentId",
          "in" : "path",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : [ "string", "integer" ],
            "format" : "int64",
            "pattern" : "([0-9]+)"
          },
          "description" : "Unique ID of the department"
        }, {
          "$ref" : "./Common.json#/components/parameters/orgId"
        } ],
        "responses" : {
          "204" : {
            "$ref" : "./Common.json#/components/responses/emptyResponse"
          }
        },
        "security" : [ {
          "iam-oauth2-schema" : [ "Desk.departments.UPDATE" ]
        }, {
          "deprecated-iam-oauth2-schema" : [ "Desk.basic.UPDATE", "Desk.settings.UPDATE" ]
        } ]
      }
    },
    "/api/v1/departments/{departmentId}/disable" : {
      "post" : {
        "tags" : [ "Department" ],
        "summary" : "Disable Department",
        "description" : "Disables a department in the help desk portal.",
        "operationId" : "disableDepartment",
        "parameters" : [ {
          "name" : "departmentId",
          "in" : "path",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : [ "string", "integer" ],
            "format" : "int64",
            "pattern" : "([0-9]+)"
          },
          "description" : "Unique ID of the department"
        }, {
          "$ref" : "./Common.json#/components/parameters/orgId"
        } ],
        "requestBody" : {
          "$ref" : "#/components/requestBodies/disableTransfer"
        },
        "responses" : {
          "422" : {
            "$ref" : "./Common.json#/components/responses/invalidDataErrorResponse"
          },
          "204" : {
            "$ref" : "./Common.json#/components/responses/emptyResponse"
          }
        },
        "security" : [ {
          "iam-oauth2-schema" : [ "Desk.departments.UPDATE" ]
        }, {
          "deprecated-iam-oauth2-schema" : [ "Desk.basic.UPDATE", "Desk.settings.UPDATE" ]
        } ]
      }
    },
    "/api/v1/departmentsByIds" : {
      "get" : {
        "tags" : [ "Department" ],
        "summary" : "Get Departments by IDs",
        "description" : "Retrieves the details of the departments whose IDs are passed in the request.",
        "operationId" : "getDepartmentsByIds",
        "x-mcp-group" : [ "Departments" ],
        "parameters" : [ {
          "name" : "departmentIds",
          "in" : "query",
          "description" : "ID(s) of the departments to retrieve  <p><b> Note:</b>  - Multiple IDs can be provided by separating them with commas   - A maximum of 50 IDs is allowed</p>",
          "required" : true,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : [ "array" ],
            "items" : {
              "type" : [ "string", "integer" ],
              "format" : "int64",
              "pattern" : "([0-9]+)"
            },
            "uniqueItems" : false
          }
        }, {
          "$ref" : "./Common.json#/components/parameters/orgId"
        } ],
        "responses" : {
          "422" : {
            "$ref" : "./Common.json#/components/responses/multipleUnprocessEntityResponse"
          },
          "204" : {
            "$ref" : "./Common.json#/components/responses/emptyResponse"
          },
          "200" : {
            "$ref" : "#/components/responses/departmentListViewArray"
          }
        },
        "security" : [ {
          "iam-oauth2-schema" : [ "Desk.basic.READ", "Desk.departments.READ" ]
        }, {
          "deprecated-iam-oauth2-schema" : [ "Desk.settings.READ" ]
        } ]
      }
    },
    "/api/v1/departments/{departmentId}/agents" : {
      "get" : {
        "tags" : [ "Department" ],
        "summary" : "Get Agents in Department",
        "description" : "Retrieves the agents in a department.",
        "operationId" : "getAgentsInDepartment",
        "x-mcp-group" : [ "Departments" ],
        "parameters" : [ {
          "name" : "fieldName",
          "in" : "query",
          "description" : "Field used to search and list agents  <p><b> Possible values:</b> firstName, lastName, name, emailId</p>",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : [ "string" ],
            "enum" : [ "firstName", "lastName", "name", "emailId" ]
          }
        }, {
          "name" : "searchStr",
          "in" : "query",
          "description" : "Search string used to match the first name, last name, or email ID <p><b>  Note:</b>  - string* searches for values that start with the string   - *string* searches for values that contain the string   - string searches for exact matches   - The string must contain at least one character</p>",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : [ "string" ],
            "maxLength" : 100,
            "minLength" : 1,
            "pattern" : "[0-9a-zA-Z_\\-\\&\\.\\$\\@\\^\\(\\)\\{\\}\\~\\=\\-\\|\\*\\+\\?\\[\\]\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+",
            "x-regex-name" : "cleartextampersand"
          }
        }, {
          "name" : "isLightAgent",
          "in" : "query",
          "description" : "Indicates whether the returned agents must be light or non-light agents  <p><b> Possible values:</b>  • true = returns light agents   • false = returns non-light agents</p>",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : [ "boolean" ]
          }
        }, {
          "name" : "sortOrder",
          "in" : "query",
          "description" : "Sort order used for the agents list <p><b>  Possible values:</b> asc, desc</p>",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : [ "string" ],
            "enum" : [ "asc", "desc" ]
          }
        }, {
          "name" : "limit",
          "in" : "query",
          "description" : "Number of agents to fetch",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : [ "integer" ],
            "format" : "int32",
            "maximum" : 200,
            "minimum" : 0,
            "pattern" : "([0-9]+)"
          }
        }, {
          "name" : "from",
          "in" : "query",
          "description" : "Index number from which the agents must be listed",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : [ "integer" ],
            "format" : "int32",
            "pattern" : "([0-9]+)"
          }
        }, {
          "name" : "isConfirmed",
          "in" : "query",
          "description" : "Indicates whether the returned agents must be confirmed or unconfirmed  <p><b> Possible values: </b> • true = returns confirmed agents   • false = returns unconfirmed agents</p>",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : [ "boolean" ]
          }
        }, {
          "name" : "status",
          "in" : "query",
          "description" : "Activation status used to filter agents <p><b>  Possible values:</b> ACTIVE, DISABLED</p>",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : [ "string" ],
            "enum" : [ "ACTIVE", "DISABLED" ]
          }
        }, {
          "name" : "departmentId",
          "in" : "path",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : [ "string", "integer" ],
            "format" : "int64",
            "pattern" : "([0-9]+)"
          },
          "description" : "Unique ID of the department"
        }, {
          "$ref" : "./Common.json#/components/parameters/orgId"
        } ],
        "responses" : {
          "204" : {
            "$ref" : "./Common.json#/components/responses/emptyResponse"
          },
          "200" : {
            "$ref" : "./Agent.json#/components/responses/agentListArray"
          }
        },
        "security" : [ {
          "iam-oauth2-schema" : [ "Desk.agents.READ", "Desk.basic.READ" ]
        }, {
          "deprecated-iam-oauth2-schema" : [ "Desk.settings.READ" ]
        } ]
      }
    },
    "/api/v1/departments/count" : {
      "get" : {
        "tags" : [ "Department" ],
        "summary" : "Get Department Count",
        "description" : "Retrieves the number of departments configured in the help desk portal.",
        "operationId" : "getDepartmentsCount",
        "x-mcp-group" : [ "Departments" ],
        "parameters" : [ {
          "name" : "isEnabled",
          "in" : "query",
          "required" : false,
          "schema" : {
            "type" : [ "boolean" ]
          },
          "style" : "form",
          "explode" : true,
          "description" : "Indicates whether departments must be filtered by enabled status  <p><b> Possible values: </b> • true = counts enabled departments   • false = counts disabled departments</p>"
        }, {
          "$ref" : "./Common.json#/components/parameters/orgId"
        } ],
        "responses" : {
          "200" : {
            "$ref" : "#/components/responses/deptCountResponse"
          }
        },
        "security" : [ {
          "iam-oauth2-schema" : [ "Desk.basic.READ", "Desk.departments.READ" ]
        }, {
          "deprecated-iam-oauth2-schema" : [ "Desk.settings.READ" ]
        } ]
      }
    },
    "/api/v1/departments/{departmentId}/dissociateAgents" : {
      "post" : {
        "tags" : [ "Department" ],
        "summary" : "Dissociate Agents from Department",
        "description" : "Dissociates agents from a department.",
        "operationId" : "dissociateAgents",
        "parameters" : [ {
          "name" : "departmentId",
          "in" : "path",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : [ "string", "integer" ],
            "format" : "int64",
            "pattern" : "([0-9]+)"
          },
          "description" : "Unique ID of the department"
        }, {
          "$ref" : "./Common.json#/components/parameters/orgId"
        } ],
        "requestBody" : {
          "$ref" : "#/components/requestBodies/dissociateAgents_agentIdsArray"
        },
        "responses" : {
          "422" : {
            "$ref" : "./Common.json#/components/responses/invalidDataErrorResponse"
          },
          "204" : {
            "$ref" : "./Common.json#/components/responses/emptyResponse"
          }
        },
        "security" : [ {
          "iam-oauth2-schema" : [ "Desk.permissions.UPDATE" ]
        }, {
          "deprecated-iam-oauth2-schema" : [ "Desk.basic.UPDATE", "Desk.settings.UPDATE" ]
        } ]
      }
    },
    "/api/v1/departments/{departmentId}/associableAgents" : {
      "get" : {
        "tags" : [ "Department" ],
        "summary" : "Get Associable Agents in Department",
        "description" : "Retrieves the associable agents in a department, with pagination support.",
        "operationId" : "getAssociableAgents",
        "x-mcp-group" : [ "Departments" ],
        "parameters" : [ {
          "name" : "from",
          "in" : "query",
          "required" : false,
          "schema" : {
            "type" : [ "integer" ],
            "format" : "int32",
            "minimum" : 0,
            "default" : 0
          },
          "style" : "form",
          "explode" : true,
          "description" : "Index number from which the agents must be listed"
        }, {
          "name" : "limit",
          "in" : "query",
          "required" : false,
          "schema" : {
            "type" : [ "integer" ],
            "format" : "int32",
            "minimum" : 0,
            "maximum" : 100
          },
          "style" : "form",
          "explode" : true,
          "description" : "Number of agents to fetch"
        }, {
          "name" : "status",
          "in" : "query",
          "required" : false,
          "schema" : {
            "type" : [ "string" ],
            "enum" : [ "ACTIVE", "DISABLED" ]
          },
          "style" : "form",
          "explode" : true,
          "description" : "Activation status used to filter agents <p><b> Possible values: </b>ACTIVE, DISABLED</p>"
        }, {
          "name" : "searchStr",
          "in" : "query",
          "required" : false,
          "schema" : {
            "type" : [ "string" ],
            "pattern" : "[0-9a-zA-Z_\\-\\&\\.\\$\\@\\^\\(\\)\\{\\}\\~\\=\\-\\|\\*\\+\\?\\[\\]\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+",
            "x-regex-name" : "cleartextampersand"
          },
          "style" : "form",
          "explode" : true,
          "description" : "Search string used to match the first name, last name, or email ID <p><b>Note:</b> - string* searches for values that start with the string - *string* searches for values that contain the string - string searches for exact matches - The string must contain at least one character</p>"
        }, {
          "name" : "fieldName",
          "in" : "query",
          "required" : false,
          "schema" : {
            "type" : [ "string" ],
            "enum" : [ "firstName", "lastName", "name", "emailId" ]
          },
          "style" : "form",
          "explode" : true,
          "description" : "Field used to search and list agents <p><b> Possible values: </b>firstName, lastName, name, emailId</p>"
        }, {
          "name" : "sortOrder",
          "in" : "query",
          "required" : false,
          "schema" : {
            "type" : [ "string" ],
            "enum" : [ "asc", "desc" ]
          },
          "style" : "form",
          "explode" : true,
          "description" : "Sort order used for the agents list <p><b> Possible values: </b>asc, desc</p>"
        }, {
          "name" : "departmentId",
          "in" : "path",
          "required" : true,
          "style" : "simple",
          "explode" : false,
          "schema" : {
            "type" : [ "string", "integer" ],
            "format" : "int64",
            "pattern" : "([0-9]+)"
          },
          "description" : "Unique ID of the department"
        }, {
          "$ref" : "./Common.json#/components/parameters/orgId"
        } ],
        "responses" : {
          "422" : {
            "$ref" : "./Common.json#/components/responses/multipleUnprocessEntityResponse"
          },
          "204" : {
            "$ref" : "./Common.json#/components/responses/emptyResponse"
          },
          "200" : {
            "$ref" : "#/components/responses/getAssociableAgentsResponse"
          }
        },
        "security" : [ {
          "iam-oauth2-schema" : [ "Desk.basic.READ", "Desk.departments.READ" ]
        }, {
          "deprecated-iam-oauth2-schema" : [ "Desk.settings.READ" ]
        } ]
      }
    },
    "/api/v1/departments" : {
      "get" : {
        "tags" : [ "Department" ],
        "summary" : "Get Departments",
        "description" : "Retrieves departments, with pagination support.",
        "operationId" : "getDepartments",
        "x-mcp-group" : [ "Departments" ],
        "parameters" : [ {
          "name" : "chatStatus",
          "in" : "query",
          "description" : "Chat status used to filter departments <p><b>Possible values:</b> AVAILABLE, DISABLED, NOT_CREATED, ${UNAVAILABLE}<b></p><p> Note:</b>${UNAVAILABLE} refers to departments that are not available for chat</p>",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : [ "string" ],
            "enum" : [ "AVAILABLE", "DISABLED", "NOT_CREATED", "${UNAVAILABLE}" ],
            "pattern" : "AVAILABLE|DISABLED|NOT_CREATED|\\$\\{UNAVAILABLE\\}"
          }
        }, {
          "name" : "searchStr",
          "in" : "query",
          "description" : "Search string used to match the first name, last name, or email ID <p><b>  Note:</b>  - string* searches for values that start with the string   - *string* searches for values that contain the string   - string searches for exact matches   - The string must contain at least one character</p>",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : [ "string" ],
            "maxLength" : 100,
            "minLength" : 1,
            "pattern" : "[0-9a-zA-Z_\\-\\&\\.\\$\\@\\^\\(\\)\\{\\}\\~\\=\\-\\|\\*\\+\\?\\[\\]\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+",
            "x-regex-name" : "cleartextampersand"
          }
        }, {
          "name" : "isEnabled",
          "in" : "query",
          "description" : "Indicates whether departments must be filtered by enabled status <p><b>Possible values:</b>• true = returns enabled departments   • false = returns disabled departments</p>",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : [ "boolean" ]
          }
        }, {
          "name" : "limit",
          "in" : "query",
          "description" : "Number of agents to fetch",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : [ "integer" ],
            "format" : "int32",
            "maximum" : 200,
            "minimum" : 0,
            "pattern" : "([0-9]+)"
          }
        }, {
          "name" : "from",
          "in" : "query",
          "description" : "Index number from which the agents must be listed",
          "required" : false,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : [ "integer" ],
            "format" : "int32",
            "pattern" : "([0-9]+)"
          }
        }, {
          "$ref" : "./Common.json#/components/parameters/orgId"
        } ],
        "responses" : {
          "204" : {
            "$ref" : "./Common.json#/components/responses/emptyResponse"
          },
          "200" : {
            "$ref" : "#/components/responses/departmentListViewArray"
          }
        },
        "security" : [ {
          "iam-oauth2-schema" : [ "Desk.basic.READ", "Desk.departments.READ" ]
        }, {
          "deprecated-iam-oauth2-schema" : [ "Desk.settings.READ" ]
        } ]
      },
      "post" : {
        "tags" : [ "Department" ],
        "summary" : "Create Department",
        "description" : "Creates a department in the help desk portal.",
        "operationId" : "addDepartment",
        "x-mcp-group" : [ "Departments" ],
        "parameters" : [ {
          "$ref" : "./Common.json#/components/parameters/orgId"
        } ],
        "requestBody" : {
          "$ref" : "#/components/requestBodies/addDepartmentJson"
        },
        "responses" : {
          "422" : {
            "$ref" : "./Common.json#/components/responses/invalidDataErrorResponse"
          },
          "200" : {
            "$ref" : "#/components/responses/getDepartmentResponse"
          }
        },
        "security" : [ {
          "iam-oauth2-schema" : [ "Desk.departments.CREATE" ]
        }, {
          "deprecated-iam-oauth2-schema" : [ "Desk.basic.CREATE", "Desk.settings.CREATE" ]
        } ]
      }
    },
    "/api/v1/departments/checkExists" : {
      "get" : {
        "tags" : [ "Department" ],
        "summary" : "Check for duplicate departments",
        "description" : "This API checks if multiple departments have the same name.",
        "operationId" : "checkDepartmentNameExist",
        "x-mcp-group" : [ "Departments" ],
        "parameters" : [ {
          "name" : "departmentName",
          "in" : "query",
          "description" : "Name of the department for which you want to check duplicate entries",
          "required" : true,
          "style" : "form",
          "explode" : true,
          "schema" : {
            "type" : [ "string" ],
            "maxLength" : 150,
            "pattern" : "[0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+"
          }
        }, {
          "$ref" : "./Common.json#/components/parameters/orgId"
        } ],
        "responses" : {
          "422" : {
            "$ref" : "./Common.json#/components/responses/multipleUnprocessEntityResponse"
          },
          "200" : {
            "$ref" : "#/components/responses/checkNameResponse"
          }
        },
        "security" : [ {
          "iam-oauth2-schema" : [ "Desk.departments.READ" ]
        }, {
          "deprecated-iam-oauth2-schema" : [ "Desk.basic.READ", "Desk.settings.READ" ]
        } ]
      }
    },
    "/api/v1/myDepartments" : {
      "get" : {
        "tags" : [ "Department" ],
        "summary" : "Get My Departments",
        "description" : "Retrieves departments associated with the current user.",
        "operationId" : "getMyDepartments",
        "x-mcp-group" : [ "Departments" ],
        "parameters" : [ {
          "name" : "isEnabled",
          "in" : "query",
          "required" : false,
          "schema" : {
            "type" : [ "boolean" ]
          },
          "style" : "form",
          "explode" : true,
          "description" : "Indicates whether departments must be filtered by enabled status <p><b>Possible values:</b>• true = returns enabled departments   • false = returns disabled departments</p>"
        }, {
          "name" : "chatStatus",
          "in" : "query",
          "required" : false,
          "schema" : {
            "type" : [ "string" ],
            "pattern" : "AVAILABLE|DISABLED|NOT_CREATED|\\$\\{UNAVAILABLE\\}"
          },
          "style" : "form",
          "explode" : true,
          "description" : "Chat status used to filter departments <p><b>Possible values:</b> AVAILABLE, DISABLED, NOT_CREATED, ${UNAVAILABLE}<b></p><p> Note:</b>${UNAVAILABLE} refers to departments that are not available for chat</p>"
        }, {
          "$ref" : "./Common.json#/components/parameters/orgId"
        } ],
        "responses" : {
          "204" : {
            "$ref" : "./Common.json#/components/responses/emptyResponse"
          },
          "200" : {
            "$ref" : "#/components/responses/departmentListViewArray"
          }
        },
        "security" : [ {
          "iam-oauth2-schema" : [ "Desk.basic.READ", "Desk.departments.READ" ]
        }, {
          "deprecated-iam-oauth2-schema" : [ "Desk.settings.READ" ]
        } ]
      }
    }
  },
  "components" : {
    "schemas" : {
      "agentData" : {
        "type" : [ "array", "null" ],
        "items" : {
          "$ref" : "./Agent.json#/components/schemas/agentIdsResponse"
        },
        "description" : "List of associable agents"
      },
      "commonDepartmentResponse" : {
        "type" : [ "object", "null" ],
        "additionalProperties" : false,
        "properties" : {
          "isAssignToTeamEnabled" : {
            "type" : [ "boolean", "null" ],
            "description" : "Indicates whether the assign-to-team functionality is enabled   <p><b>Possible values: </b> • true = assign-to-team functionality is enabled   • false = assign-to-team functionality is disabled</p>"
          },
          "chatStatus" : {
            "type" : [ "string", "null" ],
            "enum" : [ "AVAILABLE", "DISABLED", "NOT_CREATED" ],
            "description" : "Chat status of the department <p><b>Possible values:</b> AVAILABLE, DISABLED, NOT_CREATED</p>"
          },
          "hasLogo" : {
            "type" : [ "boolean", "null" ],
            "description" : "Indicates whether the department has a logo<p><b>Possible values:</b>• true = department has a logo   • false = department does not have a logo</p>"
          },
          "sanitizedName" : {
            "type" : [ "string", "null" ],
            "maxLength" : 100,
            "description" : "Sanitized Name of the department"
          },
          "isVisibleInCustomerPortal" : {
            "type" : [ "boolean", "null" ],
            "description" : "Indicates whether the department is visible in the help center<p><b>Possible values:</b>  • true = department is visible in the help center   • false = department is not visible in the help center</p>"
          },
          "creatorId" : {
            "type" : [ "string", "integer", "null" ],
            "format" : "int64",
            "pattern" : "([0-9]+)",
            "description" : "Unique ID of the user who created the department"
          },
          "description" : {
            "type" : [ "string", "null" ],
            "maxLength" : 100,
            "description" : "Short description of the department"
          },
          "isDefault" : {
            "type" : [ "boolean", "null" ],
            "description" : "Indicates whether the department is the default department in the help desk portal<p><b>Possible values: </b> • true = default department   • false = non-default department<p>"
          },
          "isEnabled" : {
            "type" : [ "boolean", "null" ],
            "description" : "Indicates whether the department is enabled <p><b>  Possible values:</b>  • true = department is enabled   • false = department is disabled</p."
          },
          "name" : {
            "type" : [ "string", "null" ],
            "maxLength" : 200,
            "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+",
            "description" : "Name of the department"
          },
          "createdTime" : {
            "type" : [ "string", "null" ],
            "maxLength" : 100,
            "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))",
            "description" : "Time at which the department was created"
          },
          "id" : {
            "type" : [ "string", "integer", "null" ],
            "format" : "int64",
            "pattern" : "([0-9]+)",
            "description" : "Unique ID of the department"
          },
          "nameInCustomerPortal" : {
            "type" : [ "string", "null" ],
            "maxLength" : 200,
            "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+",
            "description" : "Display name of the department in the help center"
          }
        },
        "required" : [ "chatStatus", "createdTime", "creatorId", "description", "hasLogo", "id", "isAssignToTeamEnabled", "isDefault", "isEnabled", "isVisibleInCustomerPortal", "name", "nameInCustomerPortal", "sanitizedName" ]
      },
      "data" : {
        "type" : [ "array", "null" ],
        "items" : {
          "$ref" : "#/components/schemas/commonDepartmentResponse"
        },
        "description" : "List of departments"
      },
      "updateDepartmentJson" : {
        "type" : [ "object", "null" ],
        "additionalProperties" : false,
        "properties" : {
          "isAssignToTeamEnabled" : {
            "type" : [ "boolean", "null" ],
            "description" : "Key that denotes if the assign to team functionality is enabled or not"
          },
          "nameInCustomerPortal" : {
            "type" : [ "string", "null" ],
            "description" : "Display name of the department in the help center",
            "maxLength" : 150,
            "pattern" : "[0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s\\|&]+",
            "x-unique" : true
          }
        }
      },
      "departmentObjectWithPrimaryDetails" : {
        "type" : [ "object", "null" ],
        "additionalProperties" : false,
        "properties" : {
          "name" : {
            "type" : [ "string", "null" ],
            "maxLength" : 200,
            "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
          },
          "id" : {
            "type" : [ "string", "integer", "null" ],
            "format" : "int64",
            "pattern" : "([0-9]+)"
          }
        },
        "required" : [ "id", "name" ]
      }
    },
    "responses" : {
      "deptCountResponse" : {
        "description" : "deptCountResponse template definitions",
        "content" : {
          "application/json" : {
            "schema" : {
              "type" : [ "object", "null" ],
              "additionalProperties" : false,
              "properties" : {
                "count" : {
                  "type" : [ "string", "integer", "null" ],
                  "format" : "int64",
                  "pattern" : "([0-9]+)",
                  "description" : "Number of departments"
                }
              },
              "required" : [ "count" ]
            },
            "examples" : {
              "Valid responses Definitions" : {
                "value" : {
                  "count" : 5
                }
              }
            }
          }
        }
      },
      "getDepartmentResponse" : {
        "description" : "getDepartmentResponse template definitions",
        "content" : {
          "application/json" : {
            "schema" : {
              "additionalProperties" : false,
              "allOf" : [ {
                "$ref" : "#/components/schemas/commonDepartmentResponse"
              }, {
                "type" : [ "object", "null" ],
                "properties" : {
                  "associatedAgentIds" : {
                    "type" : [ "array", "null" ],
                    "items" : {
                      "type" : [ "string", "integer", "null" ],
                      "format" : "int64",
                      "pattern" : "([0-9]+)"
                    },
                    "uniqueItems" : false,
                    "description" : "ID(s) of the agents associated with the department"
                  }
                },
                "required" : [ "associatedAgentIds" ],
                "additionalProperties" : false
              } ]
            },
            "examples" : {
              "Valid responses Definitions" : {
                "value" : {
                  "isAssignToTeamEnabled" : false,
                  "chatStatus" : "NOT_CREATED",
                  "hasLogo" : false,
                  "isVisibleInCustomerPortal" : true,
                  "creatorId" : "1892000000042001",
                  "description" : "With the most advanced technology, the zPhone is the world’s largest selling smartphone.",
                  "associatedAgentIds" : [ "1892000000042001", "1892000000056007" ],
                  "isDefault" : false,
                  "isEnabled" : true,
                  "name" : "zPhone",
                  "createdTime" : 1564146662000,
                  "id" : "1892000000082085",
                  "nameInCustomerPortal" : "zPhone"
                }
              }
            }
          }
        }
      },
      "departmentListViewArray" : {
        "description" : "departmentListViewArray template definitions",
        "content" : {
          "application/json" : {
            "schema" : {
              "type" : [ "object", "null" ],
              "additionalProperties" : false,
              "properties" : {
                "data" : {
                  "$ref" : "#/components/schemas/data"
                }
              },
              "required" : [ "data" ]
            },
            "examples" : {
              "Valid responses Definitions" : {
                "value" : {
                  "data" : [ {
                    "isAssignToTeamEnabled" : true,
                    "chatStatus" : "AVAILABLE",
                    "isDefault" : true,
                    "hasLogo" : true,
                    "isVisibleInCustomerPortal" : true,
                    "isEnabled" : true,
                    "name" : "Zylker",
                    "creatorId" : "1892000000042001",
                    "description" : "Zylker Inc. is a multinational technology company that designs, develops, and sells consumer electronics.",
                    "createdTime" : 1564146662000,
                    "id" : "1892000000082069",
                    "nameInCustomerPortal" : "ZylCares"
                  }, {
                    "isAssignToTeamEnabled" : true,
                    "chatStatus" : "AVAILABLE",
                    "isDefault" : false,
                    "hasLogo" : true,
                    "isVisibleInCustomerPortal" : true,
                    "isEnabled" : true,
                    "name" : "zPad",
                    "creatorId" : "1892000000042001",
                    "description" : "zPad is the most advanced tablet that brings you the never-experienced-before processing power.",
                    "createdTime" : 1566904321000,
                    "id" : "1892000000082085",
                    "nameInCustomerPortal" : "zPad"
                  } ]
                }
              }
            }
          }
        }
      },
      "getAssociableAgentsResponse" : {
        "description" : "getAssociableAgentsResponse template definitions",
        "content" : {
          "application/json" : {
            "schema" : {
              "type" : [ "object", "null" ],
              "additionalProperties" : false,
              "properties" : {
                "data" : {
                  "$ref" : "#/components/schemas/agentData"
                }
              },
              "required" : [ "data" ]
            },
            "examples" : {
              "Valid responses Definitions" : {
                "value" : {
                  "data" : [ {
                    "firstName" : "",
                    "lastName" : "case",
                    "photoURL" : null,
                    "roleId" : "1892000000056099",
                    "profileId" : "1892000000056091",
                    "emailId" : "case@zylker.com",
                    "id" : "1892000000056007",
                    "zuid" : "10687231"
                  }, {
                    "firstName" : "",
                    "lastName" : "jade",
                    "photoURL" : "https://desk.zoho.com/api/v1/agents/1892000000042001/photo?orgId=123456",
                    "roleId" : "1892000000056899",
                    "profileId" : "1892000000056091",
                    "emailId" : "jade@zylker.com",
                    "id" : "1892000000042001",
                    "zuid" : "10657727"
                  }, {
                    "firstName" : "Steve",
                    "lastName" : "Waugh",
                    "photoURL" : "https://desk.zoho.com/api/v1/agents/1892000000888059/photo?orgId=123456",
                    "roleId" : "1892000000056004",
                    "profileId" : "18920000000232043",
                    "emailId" : "stephen@zylker.com",
                    "id" : "1892000000888059",
                    "zuid" : null
                  } ]
                }
              }
            }
          }
        }
      },
      "checkNameResponse" : {
        "description" : "checkNameResponse template definitions",
        "content" : {
          "application/json" : {
            "schema" : {
              "type" : [ "object", "null" ],
              "additionalProperties" : false,
              "properties" : {
                "isDepartmentNameExist" : {
                  "type" : [ "boolean", "null" ]
                }
              },
              "required" : [ "isDepartmentNameExist" ]
            },
            "examples" : {
              "Valid responses Definitions" : {
                "value" : {
                  "isDepartmentNameExist" : true
                }
              }
            }
          }
        }
      }
    },
    "requestBodies" : {
      "agentIdsArray" : {
        "content" : {
          "application/json" : {
            "schema" : {
              "type" : [ "object" ],
              "additionalProperties" : false,
              "properties" : {
                "agentIds" : {
                  "description" : "ID(s) of the agents",
                  "type" : [ "array" ],
                  "items" : {
                    "type" : [ "string", "integer" ],
                    "format" : "int64",
                    "pattern" : "([0-9]+)"
                  },
                  "uniqueItems" : false
                }
              },
              "required" : [ "agentIds" ]
            },
            "examples" : {
              "Valid requestBody Definitions" : {
                "value" : {
                  "agentIds" : [ 1892000000056007, 1892000000056008 ]
                }
              }
            }
          }
        }
      },
      "reInviteAgents_agentIdsArray" : {
        "content" : {
          "application/json" : {
            "schema" : {
              "type" : [ "object" ],
              "additionalProperties" : false,
              "properties" : {
                "agentIds" : {
                  "description" : "ID(s) of the agents",
                  "type" : [ "array" ],
                  "items" : {
                    "type" : [ "string", "integer" ],
                    "format" : "int64",
                    "pattern" : "([0-9]+)"
                  },
                  "uniqueItems" : false
                }
              },
              "required" : [ "agentIds" ]
            },
            "examples" : {
              "Valid requestBody Definitions" : {
                "value" : {
                  "agentIds" : [ 1892000000056007, 1892000000056008 ]
                }
              }
            }
          }
        }
      },
      "associateAgents_agentIdsArray" : {
        "content" : {
          "application/json" : {
            "schema" : {
              "type" : [ "object" ],
              "additionalProperties" : false,
              "properties" : {
                "agentIds" : {
                  "type" : [ "array" ],
                  "items" : {
                    "type" : [ "string", "integer" ],
                    "format" : "int64",
                    "pattern" : "([0-9]+)"
                  },
                  "uniqueItems" : false,
                  "description" : "ID(s) of the agents to associate"
                }
              },
              "required" : [ "agentIds" ]
            },
            "examples" : {
              "Valid requestBody Definitions" : {
                "value" : {
                  "agentIds" : [ "1892000000042001", "1892000000056007" ]
                }
              }
            }
          }
        }
      },
      "disableTransfer" : {
        "content" : {
          "application/json" : {
            "schema" : {
              "type" : [ "object" ],
              "additionalProperties" : false,
              "properties" : {
                "emailNewDepartment" : {
                  "description" : "Unique ID of the department to which emails must be moved",
                  "type" : [ "string", "integer" ],
                  "format" : "int64",
                  "pattern" : "([0-9]+)"
                },
                "agentNewDepartment" : {
                  "description" : "Unique ID of the department to which agents must be moved",
                  "type" : [ "string", "integer" ],
                  "format" : "int64",
                  "pattern" : "([0-9]+)"
                }
              },
              "required" : [ ]
            },
            "examples" : {
              "Valid requestBody Definitions" : {
                "value" : {
                  "emailNewDepartment" : "1892000000082069",
                  "agentNewDepartment" : "1892000000082069"
                }
              }
            }
          }
        }
      },
      "dissociateAgents_agentIdsArray" : {
        "content" : {
          "application/json" : {
            "schema" : {
              "type" : [ "object" ],
              "additionalProperties" : false,
              "properties" : {
                "agentIds" : {
                  "type" : [ "array" ],
                  "items" : {
                    "type" : [ "string", "integer" ],
                    "format" : "int64",
                    "pattern" : "([0-9]+)"
                  },
                  "minItems" : 1,
                  "maxItems" : 100,
                  "uniqueItems" : false,
                  "description" : "ID(s) of the agents to dissociate. Minimum 1 and maximum 100 agent IDs."
                }
              },
              "required" : [ "agentIds" ]
            },
            "examples" : {
              "Valid requestBody Definitions" : {
                "value" : {
                  "agentIds" : [ "1892000000056007" ]
                }
              }
            }
          }
        }
      },
      "updateDepartmentJson" : {
        "content" : {
          "application/json" : {
            "schema" : {
              "type" : [ "object" ],
              "additionalProperties" : false,
              "properties" : {
                "isAssignToTeamEnabled" : {
                  "type" : [ "boolean" ],
                  "description" : "Indicates whether the assign-to-team functionality is enabled <p><b> Possible values: </b> • true = assign-to-team functionality is enabled   • false = assign-to-team functionality is disabled</b>"
                },
                "nameInCustomerPortal" : {
                  "type" : [ "string" ],
                  "description" : "Display name of the department in the help center",
                  "maxLength" : 150,
                  "pattern" : "[0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s\\|&]+"
                },
                "name" : {
                  "type" : [ "string" ],
                  "pattern" : "[0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s\\|&]+",
                  "x-regex-name" : "departmentName",
                  "maxLength" : 150,
                  "description" : "Name of the department",
                  "x-unique" : true
                },
                "description" : {
                  "type" : [ "string" ],
                  "maxLength" : 500,
                  "description" : "Short description of the department"
                },
                "isVisibleInCustomerPortal" : {
                  "type" : [ "boolean" ],
                  "description" : "Indicates whether the department is visible in the help center <p><b>  Possible values: </b> • true = department is visible in the help center   • false = department is not visible in the help center</p>"
                },
                "associatedAgentIds" : {
                  "type" : [ "array" ],
                  "items" : {
                    "type" : [ "string", "integer" ],
                    "format" : "int64",
                    "pattern" : "([0-9]+)",
                    "maxLength" : 11500
                  },
                  "maxLength" : 2500,
                  "minItems" : 1,
                  "maxItems" : 100,
                  "description" : "ID(s) of the agents associated with the department"
                }
              }
            },
            "examples" : {
              "Valid requestBody Definitions" : {
                "value" : {
                  "isAssignToTeamEnabled" : true,
                  "nameInCustomerPortal" : "zPhone Support"
                }
              }
            }
          }
        }
      },
      "addDepartmentJson" : {
        "content" : {
          "application/json" : {
            "schema" : {
              "additionalProperties" : false,
              "allOf" : [ {
                "$ref" : "#/components/schemas/updateDepartmentJson"
              }, {
                "type" : [ "object" ],
                "properties" : {
                  "isVisibleInCustomerPortal" : {
                    "type" : [ "boolean" ],
                    "description" : "Indicates whether the department is visible in the help center <p><b>Possible values:</b>  • true = department is visible in the help center   • false = department is not visible in the help center</p>"
                  },
                  "name" : {
                    "type" : [ "string" ],
                    "description" : "Name of the department",
                    "maxLength" : 150,
                    "pattern" : "[0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s\\|&]+",
                    "x-unique" : true
                  },
                  "description" : {
                    "type" : [ "string" ],
                    "description" : "Short description of the department",
                    "maxLength" : 500
                  },
                  "associatedAgentIds" : {
                    "type" : [ "array" ],
                    "items" : {
                      "type" : [ "string", "integer" ],
                      "format" : "int64",
                      "pattern" : "([0-9]+)"
                    },
                    "uniqueItems" : false,
                    "description" : "ID(s) of the agents to associate with the department"
                  }
                },
                "additionalProperties" : false
              } ]
            },
            "examples" : {
              "Valid requestBody Definitions" : {
                "value" : {
                  "isAssignToTeamEnabled" : false,
                  "isVisibleInCustomerPortal" : true,
                  "name" : "zPhone",
                  "description" : "With the most advanced technology, the zPhone is the world’s largest selling smartphone.",
                  "associatedAgentIds" : [ "1892000000042001", "1892000000056007" ],
                  "nameInCustomerPortal" : "zPhone"
                }
              }
            }
          }
        }
      }
    },
    "securitySchemes" : {
      "cookie-auth" : {
        "$ref" : "./Common.json#/components/securitySchemes/cookie-auth"
      },
      "org-oauth" : {
        "$ref" : "./Common.json#/components/securitySchemes/org-oauth"
      },
      "iam-oauth2-schema" : {
        "$ref" : "./Common.json#/components/securitySchemes/iam-oauth2-schema"
      },
      "deprecated-iam-oauth2-schema" : {
        "$ref" : "./Common.json#/components/securitySchemes/deprecated-iam-oauth2-schema"
      }
    }
  },
  "x-entity" : "Department"
}