Participant APIs | REST

Version:

Download Open API Specification

Save notification list associated with an employee

https://api.wealthcare.com/participant/services/participant/communications/notifications/{tpaId}/{employerId}/{participantId}

Save notification list associated with an employee

Path parameters

tpaId string Required

A unique identifier used to identify your admin instance. This value was system generated with the admin instance was created.
employerId string Required

Unique identifier for the employer. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.
participantId string Required

Participant Id

Query parameters

decrypt integer <int32>

Indicate if the URI parameters are encrypted or not. 1: encrypted, 0: decrypted, default to 0.

Response

array <object>
- TpaId string
  
  A unique identifier used to identify your admin instance. This value was system generated with the admin instance was created.
- EmprId string
  
  Unique identifier for the employer. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.
- EmployeeId string
  
  Employee Id
- DeliveryMethods array <object>
  
  Delivery Methods
  - MethodName string
    
    Method Name. Possible delivery methods are: Email, Mobile, None.
  - IsSelected boolean
    
    Is Selected. True or False depending on if participant has selected this Delivery Method.
- CustTempType integer <int32>
  
  Custom Template Type
- CustTempName string
  
  Custom Template Name
- CustTempDesc string
  
  Custom Template Description
- CustTempOptions integer <int64>
  
  Custom Template Options. Bit flags for custom options set on the communication template in WCA.