Update User Group

Update the name or description of a user group.

PATCH https://studyscience.wyzepal.com/api/v1/user_groups/{group_id}

Usage examples

#!/usr/bin/env python3

import wyzepal

# Pass the path to your wyzepalrc file here.
client = wyzepal.Client(config_file="~/wyzepalrc")

request = {
    'group_id': group_id,
    'name': 'marketing',
    'description': 'The marketing team.',

result = client.update_user_group(request)

curl -X PATCH https://studyscience.wyzepal.com/api/v1/user_groups/42 \
    -d 'name="marketing"' \
    -d 'description="The marketing team."'


Argument Example Required Description
group_id 42 Yes

The ID of the group.

name "marketing" Yes

The new name of the group.

description "The marketing team." Yes

The new description of the group.


Example response

A typical successful JSON response may look like:

    "msg": "",
    "result": "success"

An example JSON response when the user group ID is invalid:

    "code": "BAD_REQUEST",
    "msg": "Invalid user group",
    "result": "error"