✅ Insured’s preferences

Each user has their own profile settings. At the moment, these are settings for receiving notifications in various ways and about various information.

There are three types of notifications at the moment:

  • payment notifications;
  • commercial notices about our new features and changes;
  • SMS text notifications.

Notification settings

Each insured has three notification settings. Turn them on or off with the endpoints below. Send {"isAllowed": true} to turn one on, or {"isAllowed": false} to turn it off. In the endpoints, :userId is the id of the insured.

SettingEndpointStarts as (new insured)
Payment emailsPATCH /api/public/users/:userId/payment-email-preferenceOn
Marketing emailsPATCH /api/public/users/:userId/marketing-email-preferenceOff
Text messages (SMS)PATCH /api/public/users/:userId/payment-sms-preferenceOff

To see the current values, call GET /api/public/users/:userId. They are returned in the preferences object.

What "off" means

When a setting is off, the insured does not receive that kind of notification. Payment emails off means the email address of the insured gets no payment notification emails. Text messages off means the phone number of the insured gets no texts.

Things to know

Insureds who have not registered. An insured you create through the API has no login until they register an account themselves. Until then, they do not receive payment notification emails, even when payment emails are on. After they register, the setting applies as normal.

Text messages need a verified phone number. Even when text messages are on, a text is sent only if the insured has a phone number on file and that number has been verified.

Required notices. A small number of required notices, such as compliance holds and automatic cash-out notices, are sent regardless of the payment email setting.

Marketing emails. This setting records whether the insured has opted in to marketing emails about new features. It does not affect payment notification emails.


Did this page help you?