Groups

• Get groups
• Get group
• Create group
• Update group
• Delete group

Get groups

GET v3/groups returns all account groups.

[
  {
    "id": 1946039,
    "name": "All people",
    "assigned": [
      1176508223,
      1201610344,
      1202234505
    ]
  },
  {
    "id": 33838231,
    "name": "RockWall",
    "assigned": [
      12009183,
      11679192
    ]
  }
]

Get group

GET v3/groups/33838231 returns the specified group.

{
  "id": 33838231,
  "name": "abc",
  "assigned": [
    12009183,
    11679192,
    13829833,
    13592923
  ]
}

Create group

POST v3/groups creates a new group.

Request Body

{
  "name": "Executives",
  "assigned": [
    12009183,
    11679192
  ]
}

201 Created is returned along with the group JSON if the group is created successfully.

Update group

PUT v3/groups/33838231 updates an existing group.

Request Body

{
  "name": "Old Clients",
  "assigned": [
    12009183
  ]
}

200 OK is returned along with the updated group JSON if the group is updated successfully. 403 Forbidden is returned if access is denied.

Delete group

DELETE v3/groups/33838231 deletes the specified group.

Deleting a group does not delete the users assigned to it. It only removes the group itself.

204 No Content is returned if the group is deleted successfully. 403 Forbidden is returned if access is denied.