Update User Group

User Guide > Resources > Update User Group

This request changes the attributes of a user group.

Resource

PATCH /usergroups/<OID>

Where OID is the object ID of the user group.

Parameters

None

Payload

Patch Document

Fields

name Patch Operations

commonName

replace

Users

users

add, remove, replace submember

users.user

replace

Lines

lines

add, remove, replace submember

lines.line

replace

lines.skillNumber

replace

lines.incoming

replace

lines.outgoing

replace

lines.editable

replace

Response

None

Context

Authorization

Administrator

Errors

Common Errors

Example

Request
PATCH https://xelion.nl/api/v1/master/usergroups/2407745
Payload

replace group name

{
  "operations": [
      {
        "op": "replace",
        "path": "/commonName",
        "value": "Sithtroopers Elite"
      }
  ]
}

add a user to the user group, '1' is the virtual ID, value is the user profile oid

{
  "operations": [
      {
        "op": "add",
        "path": "/users/1",
        "value": "2359255"
      }
  ]
}

remove a user from the user group, value is the relation XCCUserGroupParticipant oid

{
  "operations": [
      {
        "op": "remove",
        "path": "/users/2407751"
      }
  ]
}

add a phone line to the user group, '1' is the virtual ID, value is the phone line oid

{
  "operations": [
      {
        "op": "add",
        "path": "/lines/1",
        "value": "2407649"
      },
      {
        "op": "replace",
        "path": "/lines/1/incoming",
        "value": true
      },
      {
        "op": "replace",
        "path": "/lines/1/outgoing",
        "value": false
      }
  ]
}

remove a line from the user group, value is the relation XCCConnectedUserGroup oid

{
  "operations": [
      {
        "op": "remove",
        "path": "/lines/2409122"
      }
  ]
}