eloomi v3 docs: Update a department

Request

PATCH https://api.eloomi.com/v3/units/{unitId}

Path parameters

Parameter name	Value	Description	Additional
unitId	string	eloomis ID for the department	Required

Request headers

Parameter name	Value	Description	Additional
ClientId	string	Provided by eloomi	Required
Authorization	string	Look in the documentation for the authentication endpoint on how to construct this	Required

Request body

{
    "access_groups": [
        "integer"
    ],
    "add_course_ids": [
        "integer"
    ],
    "add_department_learning_manager_emails": [
        "string"
    ],
    "add_department_learning_manager_employee_ids": [
        "string"
    ],
    "add_department_learning_manager_ids": [
        "integer"
    ],
    "add_department_organizational_manager_emails": [
        "string"
    ],
    "add_department_organizational_manager_employee_ids": [
        "string"
    ],
    "add_department_organizational_manager_ids": [
        "integer"
    ],
    "add_department_performance_manager_emails": [
        "string"
    ],
    "add_department_performance_manager_employee_ids": [
        "string"
    ],
    "add_department_performance_manager_ids": [
        "integer"
    ],
    "add_user_ids": [
        "integer"
    ],
    "code": "string",
    "leader_email": [
        "string"
    ],
    "leader_ids": [
        "integer"
    ],
    "leaders_employee_id": [
        "string"
    ],
    "leaders_employee_ids": [
        "string"
    ],
    "name": "string",
    "parent_code": "string",
    "parent_id": "integer",
    "remove_course_ids": [
        "integer"
    ],
    "remove_department_learning_manager_emails": [
        "string"
    ],
    "remove_department_learning_manager_employee_ids": [
        "string"
    ],
    "remove_department_learning_manager_ids": [
        "integer"
    ],
    "remove_department_organizational_manager_emails": [
        "string"
    ],
    "remove_department_organizational_manager_employee_ids": [
        "string"
    ],
    "remove_department_organizational_manager_ids": [
        "integer"
    ],
    "remove_department_performance_manager_emails": [
        "string"
    ],
    "remove_department_performance_manager_employee_ids": [
        "string"
    ],
    "remove_department_performance_manager_ids": [
        "integer"
    ],
    "remove_user_ids": [
        "integer"
    ],
    "user_emails": [
        "email"
    ],
    "user_ids": [
        "integer"
    ]
}

Properties

Name	Example	Description	Additional
access_groups[]	[ 1, 2 ]	IDs of the access groups that will be inherited by department members	Optional
add_course_ids[]	[ 2, 4 ]	IDs of the courses that should be added to the department	Optional
add_department_learning_manager_emails[]	[ "[email protected]", "[email protected]" ]	Emails of the learning managers in the department to be added	Optional
add_department_learning_manager_employee_ids[]	[ "EI111", "EI222" ]	Employee Id's of the learning managers in the department to be added	Optional
add_department_learning_manager_ids[]	[ 15, 16 ]	IDs of the learning managers in the department to be added	Optional
add_department_organizational_manager_emails[]	[ "[email protected]", "[email protected]" ]	Emails of the organization managers in the department to be added	Optional
add_department_organizational_manager_employee_ids[]	[ "EI111", "EI222" ]	Employee Id's of the organization managers in the department to be added	Optional
add_department_organizational_manager_ids[]	[ 15, 16 ]	IDs of the organization managers in the department to be added	Optional
add_department_performance_manager_emails[]	[ "[email protected]", "[email protected]" ]	Emails of the performance managers in the department to be added	Optional
add_department_performance_manager_employee_ids[]	[ "EI111", "EI222" ]	Employee Id's of the performance managers in the department to be added	Optional
add_department_performance_manager_ids[]	[ 15, 16 ]	IDs of the performance managers in the department to be added	Optional
add_user_ids[]	[ 2, 4 ]	IDs of the users that should be added to the department	Optional
code	"MAR02"	Your companys id for the department	Optional
leader_email[]	[ "[email protected]", "[email protected]" ]	Emails of the leaders of the department	Optional
leader_ids[]	[ 3, 4 ]	IDs of the leaders of the department	Optional
leaders_employee_id[]	[ "E001", "E002" ]	Employee IDs of the leaders of the department	Optional
leaders_employee_ids[]	[ "E001", "E002" ]	Employee IDs of the leaders of the department	Optional
name	"Inbound Marketing"	Department name is it should appear in eloomi	Optional
parent_code	"MAR01"	Your companys id for the parent department	Optional
parent_id	1337	eloomis internal id of the parent department	Optional
remove_course_ids[]	[ 1, 3 ]	IDs of the courses that should be removed from the department	Optional
remove_department_learning_manager_emails[]	[ "[email protected]", "[email protected]" ]	Emails of the learning managers in the department to be removed	Optional
remove_department_learning_manager_employee_ids[]	[ "EI111", "EI222" ]	Employee Id's of the learning managers in the department to be removed	Optional
remove_department_learning_manager_ids[]	[ 15, 16 ]	IDs of the learning managers in the department to be removed	Optional
remove_department_organizational_manager_emails[]	[ "[email protected]", "[email protected]" ]	Emails of the organization managers in the department to be removed	Optional
remove_department_organizational_manager_employee_ids[]	[ "EI111", "EI222" ]	Employee Id's of the organization managers in the department to be removed	Optional
remove_department_organizational_manager_ids[]	[ 15, 16 ]	IDs of the organization managers in the department to be removed	Optional
remove_department_performance_manager_emails[]	[ "[email protected]", "[email protected]" ]	Emails of the performance managers in the department to be removed	Optional
remove_department_performance_manager_employee_ids[]	[ "EI111", "EI222" ]	Employee Id's of the performance managers in the department to be removed	Optional
remove_department_performance_manager_ids[]	[ 15, 16 ]	IDs of the performance managers in the department to be removed	Optional
remove_user_ids[]	[ 1, 3 ]	IDs of the users that should be removed from the department	Optional
user_emails[]	[ "[email protected]" ]	Emails of the users in the department	Optional
user_ids[]	[ 5, 6 ]	IDs of the users in the department	Optional

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code	Description	Resource
200	OK Department updated	DepartmentSuccess
400	Bad Request Invalid input	GenericSuccess
401	Unauthorized Not allowed	ErrorSuccess