Make updates to a Communication
Update the status of a specific communication for a participant, allowing them to mark it as read or delete it as needed.
Request
-
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 user whose feature information is being retrieved.
-
communicationKey integer <int32> Required
Communication Key
-
isRead boolean Required
Indicates whether the communication should be marked as read (true) or unread (false). This parameter is required to specify the desired read status.
-
communicationVersion integer <int32> Required
Specifies the version of the communication. A value of 1 indicates the standard WCA communication offerings, while a value of 2 will be used for future offerings. This parameter is required for proper processing.
-
action boolean
Determines the action to take on the communication. Set to true to mark the communication for deletion, or false to take no action. This parameter is optional and defaults to no action if not provided.
-
decrypt integer <int32>
Indicate if the URI parameters are encrypted or not. Use 1 for encrypted, 0 for decrypted (default is 0). This affects how the API interprets the incoming identifiers.
Response
No response yet.No response yet.