mirror of
https://github.com/zulip/zulip.git
synced 2026-07-12 21:04:41 +08:00
7677ba2d2b
This renames 'group_id' to 'user_group_id' in the api docs to remove the naming mismatch between the url config and the docs and eventually remove the 'user_groups' endpoints from 'pending_endpoints' in test_openapi.py.
33 lines
693 B
Markdown
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)}
|