users

Update notification settings for a user

Changed on

Updates and returns notification settings for a specific user. Requires MANAGE_USERS permission if editing other users.

post/user/{userId}/settings/notifications

Request

  • Base URL: http://localhost:5055/api/v1
  • URL: http://localhost:5055/api/v1/user/{userId}/settings/notifications
  • Auth: one of:
    • API key in cookie connect.sid
    • API key in header X-Api-Key

Path parameters

userIdnumber required

Request body

emailEnabledboolean
pgpKeystring nullable
discordEnabledboolean
discordEnabledTypesnumber nullable
discordIdsstring[] nullable
pushbulletAccessTokenstring nullable
pushoverApplicationTokenstring nullable
pushoverUserKeystring nullable
pushoverSoundstring nullable
telegramEnabledboolean
telegramBotUsernamestring nullable
telegramChatIdstring nullable
telegramMessageThreadIdstring nullable
telegramSendSilentlyboolean nullable

Response

Updated user notification settings returned

emailEnabledboolean
pgpKeystring nullable
discordEnabledboolean
discordEnabledTypesnumber nullable
discordIdsstring[] nullable
pushbulletAccessTokenstring nullable
pushoverApplicationTokenstring nullable
pushoverUserKeystring nullable
pushoverSoundstring nullable
telegramEnabledboolean
telegramBotUsernamestring nullable
telegramChatIdstring nullable
telegramMessageThreadIdstring nullable
telegramSendSilentlyboolean nullable

Changes

    • warning

      removed the request property

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status