Managing Groups
This series of API calls allows you to create, edit and delete groups within a Rev account.
NOTE: As of Rev v7.18, these APIs are available.
Create
POST
/api/v2/groups
Request Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| name | string | Group name. Must be a unique name within the Rev account. | Yes |
| userIds | string | GUIDs for the user being added to this group. | |
| roleIds | string | GUIDs for the roles assigned to the users in this group. See Managing Users to get all role ids. |
Example Request
{
"name": "GROUP Name",
"userIds": [
"fe73fec5-35c4-4f55-abdc-0192f326f9a0"
],
"roleIds": [
"c101d259-c02e-494e-8e3b-e4d043f85ba9"
]
}
Example Response
{
"groupId": "dfc940a3-0ab6-4ec7-b831-e88372053b08"
}
Response Codes
| Code | Description |
|---|---|
| 200 | ok |
| 401 | Unauthorized error |
| 500 | Internal server error |
Edit
PUT
/api/v2/groups/{groupId}
Request Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| groupId | path | GUID for the group. | Yes |
| name | string | Group name. Must be a unique name within the Rev account. | |
| userIds | string | GUID for the users being added to the group. | |
| roleIds | string | GUID for the roles assigned to the users in the group. See Managing Users to get all role ids. |
Example Request
{
"name": "GROUP Name",
"userIds": [
"fe73fec5-35c4-4f55-abdc-0192f326f9a0"
],
"roleIds": [
"c101d259-c02e-494e-8e3b-e4d043f85ba9"
]
}
Response Codes
| Code | Description |
|---|---|
| 200 | ok |
| 401 | Unauthorized error |
| 500 | Internal server error |
Delete
DELETE
/api/v2/groups/{groupId}
Request Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| groupId | path | GUID for the group. | Yes |
Response Codes
| Code | Description |
|---|---|
| 200 | ok |
| 401 | Unauthorized error |
| 500 | Internal server error |
- Create
-
Create
POST/api/v2/groupsRequest Parameters
Name Type Description Required name string Group name. Must be a unique name within the Rev account. Yes userIds string GUIDs for the user being added to this group. roleIds string GUIDs for the roles assigned to the users in this group. See Managing Users to get all role ids. Example Request
{ "name": "GROUP Name", "userIds": [ "fe73fec5-35c4-4f55-abdc-0192f326f9a0" ], "roleIds": [ "c101d259-c02e-494e-8e3b-e4d043f85ba9" ] }Example Response
{ "groupId": "dfc940a3-0ab6-4ec7-b831-e88372053b08" }Response Codes
Code Description 200 ok 401 Unauthorized error 500 Internal server error - Edit
-
Edit
PUT/api/v2/groups/{groupId}Request Parameters
Name Type Description Required groupId path GUID for the group. Yes name string Group name. Must be a unique name within the Rev account. userIds string GUID for the users being added to the group. roleIds string GUID for the roles assigned to the users in the group. See Managing Users to get all role ids. Example Request
{ "name": "GROUP Name", "userIds": [ "fe73fec5-35c4-4f55-abdc-0192f326f9a0" ], "roleIds": [ "c101d259-c02e-494e-8e3b-e4d043f85ba9" ] }Response Codes
Code Description 200 ok 401 Unauthorized error 500 Internal server error - Delete
-
Delete
DELETE/api/v2/groups/{groupId}Request Parameters
Name Type Description Required groupId path GUID for the group. Yes Response Codes
Code Description 200 ok 401 Unauthorized error 500 Internal server error