zulip/templates/zerver/api/update-user-group.md

Update User Group

Update the name or description of a user group.

PATCH {{ api_url }}/v1/user_groups/{group_id}

Usage examples

{start_tabs} {tab|python}

{generate_code_example(python)|/user_groups/{group_id}:patch|example}

{tab|curl}

curl -X PATCH {{ api_url }}/v1/user_groups/42 \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY \
    -d 'name="marketing"' \
    -d 'description="The marketing team."'

{end_tabs}

Arguments

{generate_api_arguments_table|zulip.yaml|/user_groups/{group_id}:patch}

Response

Example response

A typical successful JSON response may look like:

{generate_code_example|/user_groups/{group_id}:patch|fixture(200)}

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

{generate_code_example|/user_groups/{group_id}:patch|fixture(400)}