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

33 lines
693 B
Markdown

# Update a user group
{generate_api_description(/user_groups/{user_group_id}:patch)}
## Usage examples
{start_tabs}
{tab|python}
{generate_code_example(python)|/user_groups/{user_group_id}:patch|example}
{tab|curl}
{generate_code_example(curl)|/user_groups/{user_group_id}:patch|example}
{end_tabs}
## Parameters
{generate_api_arguments_table|zulip.yaml|/user_groups/{user_group_id}:patch}
## Response
#### Example response
A typical successful JSON response may look like:
{generate_code_example|/user_groups/{user_group_id}:patch|fixture(200)}
An example JSON response when the user group ID is invalid:
{generate_code_example|/user_groups/{user_group_id}:patch|fixture(400)}