Participant APIs | REST

Version:

Download Open API Specification

Make updates to a Communication

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

With this operation participants can mark communications as read, or delete them, directly in your products through the API.

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
communicationKey integer <int32> Required

Communication Key

Query parameters

isRead boolean Required

True = Set to read, False = Set to unread
communicationVersion integer <int32> Required

Indicates which version of communication this is. A one indicates the standard WCA communication offerings. A two will be used for future offerings.
action boolean

Mark for deletion (True: delete, False: no action)
decrypt integer <int32>

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