Update insuredā€™s payment email notifications

šŸ“˜

API Refs

URI Parameters

NameTypeDescriptionRequired
userIdnumberinsure idyes

Request body

NameTypeDescriptionRequired
isAllowedbooleanEnable or Disable notificationsyes

Example

  1. Get insured information Request with userId = 1;
  2. Get insured information Response:
    {
      "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 payment email notifications Request with userId = 1:
    {
      "isAllowed": true
    }
    
  4. Get insured information Request with userId = 1;
  5. Get insured information Response:
    {
      "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": true, // changed
        "marketingEmailsAllowed": false,
        "paymentSMSAllowed": false
      }
    }
    

Description

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