Skip to navigation
API ReferenceNotificationsUser Preferences

Update preferences

Updates notification preferences with explicit events, opt-in, or opt-out operations. | (UserNotificationPreferencesUpdateRequest) -> (NotificationUserPreferences1)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
add_events_by_channelmap from strings to lists of enums or nullOptional
opt_in_to_all_on_channelslist of enums or nullOptional
Allowed values:
opt_out_of_all_on_channelslist of enums or nullOptional
Allowed values:
remove_events_by_channelmap from strings to lists of enums or nullOptional
set_events_by_channelmap from strings to lists of enums or nullOptional

Response

Successful Response
_idstring
created_at_timestampstringformat: "date-time"
last_edited_at_timestampstringformat: "date-time"
schema_versioninteger
user_idstring

Must be a string starting with user_

email_eventslist of enumsOptional
push_eventslist of enumsOptional
sms_eventslist of enumsOptional

Errors

422
Unprocessable Entity Error