Update a user group

Update the name or description of a user group.

PATCH https://studyscience.wyzepal.com/api/v1/user_groups/{user_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": user_group_id,
    "name": "marketing",
    "description": "The marketing team.",

result = client.update_user_group(request)

curl -sSX PATCH https://studyscience.wyzepal.com/api/v1/user_groups/1 \
    --data-urlencode 'name=marketing team' \
    --data-urlencode 'description=The marketing team.'


user_group_id integer required in path

Example: 1

The ID of the target user group.

name string required

Example: marketing team

The new name of the group.

description string required

Example: The marketing team.

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"