Participant APIs | REST

Version:
Download Open API Specification

Make updates to a Communication

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

Update the status of a specific communication for a participant, allowing them to mark it as read or delete it as needed.

  • tpaId string Required

    A unique identifier used to identify your admin instance. This value is system generated when 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

    Unique identifier for the participant whose features are being queried.

  • communicationKey integer <int32> Required

    Communication Key

  • isRead boolean Required

    Indicates whether the communication should be marked as read (true) or unread (false).

  • communicationVersion integer <int32> Required

    Specifies the version of the communication; 1 for standard offerings, 2 for future offerings.

  • action boolean

    Determines the action to take on the communication: true to mark for deletion, false for no action.

  • decrypt integer <int32>

    Indicate if the URI parameters are encrypted or not. Use 1 for encrypted and 0 for decrypted; defaults to 0 if not specified.