Update insured’s SMS text notifications

📘

API Refs

• Production: Update insured’s SMS text notifications
• Staging: Update insured’s SMS text notifications

URI Parameters

Name	Type	Description	Required
userId	number	insure id	yes

Request body

Name	Type	Description	Required
isAllowed	boolean	Enable or Disable notifications	yes

Example

1. Get insured information Request with userId = 1;
2. Get insured information Response:
   JSON

   {
     "id": 1,
     "email": "[email protected]",
     "firstName": "John",
     "lastName": "Smith",
     "address": [
       {
         "address1": "11 Birch Hill Street",
         "address2": "Apt. 123",
         "city": "Bronx",
         "postalCode": "10023",
         "state": "NY",
         "phone": "123-456-7890",
         "alias": "Home"
       }
     ],
     "preferences": {
       "paymentEmailsAllowed": false,
       "marketingEmailsAllowed": false,
       "paymentSMSAllowed": false
     }
   }
   

3. Update insured’s SMS text notifications Request with userId = 1:
   JSON

   {
     "isAllowed": true
   }
   

4. Get insured information Request with userId = 1;
5. Get insured information Response:
   JSON

   {
     "id": 1,
     "email": "[email protected]",
     "firstName": "John",
     "lastName": "Smith",
     "address": [
       {
         "address1": "11 Birch Hill Street",
         "address2": "Apt. 123",
         "city": "Bronx",
         "postalCode": "10023",
         "state": "NY",
         "phone": "123-456-7890",
         "alias": "Home"
       }
     ],
     "preferences": {
       "paymentEmailsAllowed": false,
       "marketingEmailsAllowed": false,
       "paymentSMSAllowed": true //changed
     }
   }
   

Description

If you are not interested in SMS text notifications, use this endpoint to disable this option.
True means turning on notifications, in turn, falls turns them off.