Skip to main content

Notification Settings


Use Notification Settings to configure appointment and service notification channels.

Available channels and validation rules derive from the account notification configuration.


Notification settings screen with WhatsApp, SMS, and email options

This screen includes:

#ElementDescription
1Phone number displayDisplays the verified account phone number
2Contact methodsDisplays WhatsApp, SMS, and Email options
3Selection controlsEnables or disables notification channels
4Save Changes actionSaves notification preferences
5Update Details actionOpens contact information update flow
6Validation modalDisplays validation errors when required

Workflow

  1. Open Notification Settings.
  2. Render available notification channels.
  3. Select one or more contact methods.
  4. Update contact details when required.
  5. Save notification preferences.
  6. Refresh the notification state.

Regional Restrictions

RegionBehavior
+972SMS unavailable
+34SMS unavailable

Synchronization Behavior

  • Notification preferences apply at the account level.
  • Preference updates synchronize across supported platforms.
  • Existing opt-out restrictions override API updates.
  • Linked partner platforms may provide default notification preferences.

Validation rules

ScenarioApp BehaviorSDK Output
No contact methods selectedBlock save actionerror = contact_method_required
Email enabled with invalid emailDisplay validation errorerror = invalid_email
SMS enabled with invalid phoneDisplay validation errorerror = invalid_phone
SMS unsupported for regionDisable SMS optionsms = restricted
WhatsApp or SMS opt-out enforcedDisable restricted channelchannel = disabled
Session invalidBlock accessstate = unauthenticated
SDK version unsupportedDisplay upgrade errorstatus = 422

Actions

ScenarioApp BehaviorSDK Output
Notification settings openedLoad notification preferencesPUT /api/v3/account/notifications
Contact method updatedUpdate pending preference statepreferences = updated
Save Changes selectedPersist notification preferencesPOST /api/v3/account/notifications
Preferences savedRefresh notification statestate = saved
Update Details selectedOpen contact update flownavigation = update_details
Save rejectedPreserve previous valid statestate = unchanged

Endpoint Resources

Notification Settings

PUT 

v3/account/notifications

Returns notification settings and available channels

Save Notification Preferences

POST 

v3/account/notifications

Persists notification preferences