Create User Group

User Guide > Resources > Create User Group

Response

Object Response < XCCUserGroup >

The user group object. Created sub-objects are updated with their object ID.

Context

Authorization

Administrator

Errors

Common Errors

HTTP code Xelion code Description

400

10203

User is already connected to phone line

Example

Request
POST https://xelion.nl/api/v1/master/usergroups
Payload
{
    "commonName": "Sithtroopers",
    "objectType": "XCCUserGroup",
    "users": [
        {
            "user": {
                "oid": "2359082",
                "objectType": "UserProfile"
            },
            "objectType": "XCCUserGroupParticipant"
        }
    ],
    "lines": [
        {
            "line": {
                "commonName": "Stormtroopers",
                "oid": "2407649",
                "objectType": "XCCPhoneLine"
            },
            "skillNumber": 0,
            "incoming": true,
            "outgoing": false,
            "editable": "INCOMINGANDOUTGOING",
            "objectType": "XCCConnectedUserGroup"
        }
    ]
}
Response
{
    "object": {
        "users": [
            {
                "user": {
                    "permissions": "ReadWriteRemove",
                    "commonName": "Sithtrooper II",
                    "oid": "2359082",
                    "objectType": "UserProfile"
                },
                "oid": "2407749",
                "objectType": "XCCUserGroupParticipant"
            }
        ],
        "lines": [
            {
                "line": {
                    "permissions": "ReadWriteRemove",
                    "commonName": "Stormtroopers",
                    "oid": "2407649",
                    "objectType": "XCCPhoneLine"
                },
                "skillNumber": 0,
                "incoming": true,
                "outgoing": false,
                "editable": "INCOMINGANDOUTGOING",
                "oid": "2409122",
                "objectType": "XCCConnectedUserGroup"
            }
        ],
        "permissions": "ReadWriteRemove",
        "commonName": "Sithtroopers",
        "oid": "2407745",
        "objectType": "XCCUserGroup"
    },
    "links": [
        {
            "rel": "self",
            "href": "http://sip.xelion.nl/api/v1/master/usergroups/2407745",
            "method": "GET"
        }
    ]
}