Skip to content

Update group

Request to update existing group:

PUT /api/v2/groups/<group-id>.json

HTTP body should contain JSON formatted profile of group to update.

For example:

{
    "group": {
        "name": "New Group Name"
    }
}

Response contains HTTP status code as shown in the following table.

Response Description
200 OK

Group has been successfully updated.

A response contains a JSON formatted group's data after update.
403 Forbidden The request cannot be completed because API user has no permission to edit groups
400 Bad Request

The request cannot be completed because supplied JSON object has invalid data.

When response has content type application/json, then it contains more detailed description of error in JSON format like:

{"error": "InvalidRecord","description": "Record Validation errors","details": ["name": "Group with such name exists already"]}