zulip/templates/zerver/api/update-notification-setting...

40 lines
1.1 KiB
Markdown
Raw Normal View History

# Update notification settings
This endpoint is used to edit the user's global notification settings.
See [this endpoint](/api/update-subscription-properties) for
per-stream notification settings.
`PATCH {{ api_url }}/v1/settings/notifications`
## 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}
## Arguments
{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)}