mirror of
https://github.com/zulip/zulip.git
synced 2026-07-12 21:04:41 +08:00
817ee5c6b2
The term `parameter` is a better word than `argument` for data passed to an API endpoint; this is why OpenAPI uses in their terminology. Replace `argument` with `parameter` in the API docs to improve their readability. Fixes #15435.
36 lines
943 B
Markdown
36 lines
943 B
Markdown
# Update notification settings
|
|
|
|
{generate_api_description(/settings/notifications:patch)}
|
|
|
|
## Usage examples
|
|
|
|
{start_tabs}
|
|
{tab|python}
|
|
|
|
{generate_code_example(python)|/settings/notifications:patch|example}
|
|
|
|
{tab|curl}
|
|
|
|
{generate_code_example(curl, include=["enable_offline_push_notifications", "enable_online_push_notifications"])|/settings/notifications:patch|example}
|
|
|
|
{end_tabs}
|
|
|
|
## Parameters
|
|
|
|
{generate_api_arguments_table|zulip.yaml|/settings/notifications:patch}
|
|
|
|
## Response
|
|
|
|
#### Return values
|
|
|
|
The server will return the settings that have been changed after the request,
|
|
with their new value. Please note that this doesn't necessarily mean that it
|
|
will return all the settings passed as parameters in the request, but only
|
|
those ones that were different than the already existing setting.
|
|
|
|
#### Example response
|
|
|
|
A typical successful JSON response may look like:
|
|
|
|
{generate_code_example|/settings/notifications:patch|fixture(200)}
|