Details¶

Fields¶

Links¶

HTTP DELETE¶

Deletes a review group.

This will disassociate the group from all review requests previously targetting the group, and permanently delete the group.

It is best to only delete empty, unused groups, and to instead change a group to not be visible if it’s on longer needed.

HTTP GET¶

Retrieve information on a review group.

Some basic information on the review group is provided, including the name, description, and mailing list (if any) that e-mails to the group are sent to.

The group links to the list of users that are members of the group.

HTTP PUT¶

Updates an existing review group.

All the fields of a review group can be modified, including the name, so long as it doesn’t conflict with another review group.

Extra data can be stored on the group for later lookup by passing extra_data.key_name=value. The key_name and value can be any valid strings. Passing a blank value will remove the key. The extra_data. prefix is required.

Examples¶

$ curl http://reviews.example.com/api/groups/devgroup/ -H "Accept: application/json"

Vary: Accept, Cookie
ETag: f95a5080972abcf7ef8004b284af069a287972f7
Content-Type: application/vnd.reviewboard.org.review-group+json
X-Content-Type-Options: nosniff

{
  "group": {
    "absolute_url": "http://reviews.example.com/groups/devgroup/", 
    "display_name": "Dev Group", 
    "extra_data": {}, 
    "id": 1, 
    "invite_only": false, 
    "links": {
      "delete": {
        "href": "http://reviews.example.com/api/groups/devgroup/", 
        "method": "DELETE"
      }, 
      "review_group_users": {
        "href": "http://reviews.example.com/api/groups/devgroup/users/", 
        "method": "GET"
      }, 
      "self": {
        "href": "http://reviews.example.com/api/groups/devgroup/", 
        "method": "GET"
      }, 
      "update": {
        "href": "http://reviews.example.com/api/groups/devgroup/", 
        "method": "PUT"
      }
    }, 
    "mailing_list": "devgroup@example.com", 
    "name": "devgroup", 
    "url": "/groups/devgroup/", 
    "visible": true
  }, 
  "stat": "ok"
}