Request

POST https://api.eloomi.com/v3/units

Query parameters

Parameter name Value Description Additional
unique string

Should check unique constraint on insert

Possible values are:

  • code
Optional

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"
    ],
    "code": "string",
    "leader_employee_ids": [
        "string"
    ],
    "leader_ids": [
        "integer"
    ],
    "name": "string",
    "parent_code": "string",
    "parent_id": "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
code "MAR02"

Your companys id for the department

Optional
leader_employee_ids[] [ "E001", "E002" ]

Employee IDs of the leaders of the department

Optional
leader_ids[] [ 3, 4 ]

IDs of the leaders of the department

Optional
name "Inbound Marketing"

Department name is it should appear in eloomi

Required
parent_code "MAR01"

Your companys id for the parent department

Optional
parent_id 1337

eloomis internal id of the parent department

Optional
user_emails[] [ "support@eloomi.com" ]

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 created

DepartmentSuccess
400 Bad Request

Request contained invalid data

GenericSuccess
401 Unauthorized

Not allowed

ErrorSuccess