mirror of https://github.com/zulip/zulip.git synced 2026-07-03 21:10:12 +08:00

Kartik Srivastava 7677ba2d2b api docs: Rename 'group_id' to 'user_group_id'.

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.

2020-08-26 15:40:19 -07:00

693 B

Raw Blame History

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)}

693 B Raw Blame History