UserIncidentNotificationSettingsResource

Update incident notification settings for a user

Updates incident notification preferences for the specified user.

Required API key permissions

  • Scope: user-incident-notification-settings:update
  • Accepted key types: organization API key (org-wide), personal access token (org-wide)
  • Access: User-linked keys (personal access tokens) may only act on their own user.
  • Self access: personal access tokens may write their linked user's resource even when the user belongs to multiple organizations.
  • Notes: Personal access tokens may only modify their linked user's settings. Organization API keys must pass ?provision=true to overwrite settings that are not provisioned (managed by the user in the UI).
put/api/public/v1/user/{userId}/incident-notification-settings

Request

Path parameters

userIdstring uuid required

Query parameters

organizationIdstring uuid
provisionboolean

When true, the created or updated resource is marked as provisioned and becomes read-only in the web UI. Defaults to false on create. On update, omitting this parameter preserves the existing provisioned state. Not available for personal access tokens.

Request body

phoneNumberstring nullable
shouldSendSMSboolean nullable
delayInMinSMSinteger nullable
severitiesSMSstring[] nullable
shouldCallVoiceboolean nullable
delayInMinVoiceinteger nullable
severitiesVoicestring[] nullable
shouldSendPushboolean nullable
delayInMinPushinteger nullable
severitiesPushstring[] nullable
shouldSendEmailboolean nullable
delayInMinEmailinteger nullable
severitiesEmailstring[] nullable
disabledIntentsEmailstring[] nullable
disabledIntentsVoicestring[] nullable
disabledIntentsPushstring[] nullable
disabledIntentsSMSstring[] nullable

Response

OK

userIdstring uuid required
isProvisionedboolean
phoneNumberstring nullable
shouldSendSMSboolean nullable
delayInMinSMSinteger nullable
severitiesSMSstring[] nullable
shouldCallVoiceboolean nullable
delayInMinVoiceinteger nullable
severitiesVoicestring[] nullable
shouldSendPushboolean nullable
delayInMinPushinteger nullable
severitiesPushstring[] nullable
shouldSendEmailboolean nullable
delayInMinEmailinteger nullable
severitiesEmailstring[] nullable
disabledIntentsEmailstring[] nullable
disabledIntentsVoicestring[] nullable
disabledIntentsPushstring[] nullable
disabledIntentsSMSstring[] nullable

Changes

No recorded changes to this operation across all 1 revision of this API.