Participant APIs | REST

Version:

Download Open API Specification

Returns a list of participant communications

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

Returns a list of participant communications

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

type string

Communication Type, 1: the letter type of items are returned, otherwise the non-letter types (Email and SMS) of items are returned.
decrypt integer <int32>

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

Indicates if letters communications are included in the response. 1: included, 0: excluded.

Response

array <object>
- CommHistKey integer <int64>
  
  Communication History Key (id)
- CustTempType integer <int32>
  
  Custom Template Type - Enum CustomTemplateType (ie: Billing Address Change, Shipping Address Change)
- CustTempName string
  
  Custom Template Name
- CustTempKey integer <int32>
  
  Custom Template Key (id)
- ChannelKey integer <int32>
  
  Channel Key - Enum CommunicationChannel (0 = None, 1 = Email, 2 = Mobile, 3 = Both, 4 = LetterCommunication, 8 = NotifyEmail, 16 = MailedLetter, 32 = SendEmailToTaxFormsAcctHolders)
- FormatKey integer <int32>
  
  Format Key - Enum CommunicationFormat (1 = Text, 2 = HTML)
- Subject string
  
  Email Subject Line
- MobileNumber string
  
  Mobile Number
- InsertDte string <date-time>
  
  Insert Date (DateTime)
- UpdateDte string <date-time>
  
  Update Date (Nullable DateTime)
- CommunicationType enum<string>
  
  Communication Type
  
  Possible values: Email SMS Letter