Create Local Department (since 1.1)

A Local Department is a second-level organizational unit in enterprise Speakap, right below Business Units. It is the subgroup of a single Business Unit (its parent group). The Local Department is an intersection of a global Department and the parent Business Unit, .i.e., all members of a Local Department are also member of their parent and the global Department.


POST https://api.speakap.io/networks/:eid/local-departments/

Since

1.1

Use cases

  • Create empty Local Department
  • Create Local Department from existing basic (i.e., public, restricted, private or secret) group

Request

URI:/networks/{enterpriseEID}/local-departments/
Method:POST
Content-Type:application/json

Authentication

OAuth 2.0

Parameters

Name Type Description
enterpriseEID EID Enterprise network EID

Request body

Name Type Description
name string Unique name for the Business Unit
businessUnit object Optional Parent Business Unit
businessUnit. EID EID Unique entity identifier
businessUnit. type string “group”
department object Optional Umbrella department
department. EID EID Unique entity identifier
department. type string “group”
group object Optional Existing group
group. EID EID Unique entity identifier
group. type string “group”

Examples

{
    "name": "IT Dept",
    "businessUnit": {
        "EID": "0ABCDEF123456789",
        "type": "group"
    },
    "department": {
        "EID": "FEDCBA1234567890",
        "type": "group"
    }
}

Response

201
Successful creation: returns a Feedback object
400
Invalid data: returns an Error object
403
Unauthorized: returns an Error object
404
Unknown network: returns an Error object