Basic request:

POST https://{APIDOAMIN}/api-v1/groups/create

Parameters

• name: Required; the human readable name of the group
• type: Required; the type of group – see Working with Groups
• parent_uuid: Optional; the uuid of the parent entity

Responses:

1. When no parent entity is specified

{
    "message": "Group created",
    "data": {
        "uuid": "6e6c3c25-2896-4f69-90b2-1a50605f2cc5",
        "name": "NHS",
        "type": "INST",
        "parent": {
            "name": "PfP Test Organisation",
            "uuid": null
        }
    }
}

2. When a parent entity is specified

{
    "message": "Group created",
    "data": {
        "uuid": "38b427d5-0733-4731-8a65-12655da39b82",
        "name": "An example department",
        "type": "DEPT",
        "parent": {
            "name": "NHS",
            "uuid": "6e6c3c25-2896-4f69-90b2-1a50605f2cc5"
        }
}