Participant APIs | REST

Version:
Download Open API Specification

Add an annoncement

https://beta.api.wealthcare.com/participant/services/portalinfo/announcement

Allows you to create a new announcement in the portal, which can be used to communicate important information to participants. This operation is typically used to inform users about updates, events, or changes relevant to their benefits.

  • TpaId string

    Unique id of the TPA

  • InfoKey integer <int32>

    Portal Info Key

  • InfoName string

    Portal Info Name

  • InfoDesc string

    Portal Info Description

  • InfoDate string <date-time>

    Portal Info Date

  • ExpireDate string <date-time>

    Portal Info Expiration Date

  • LastUpdateDate string <date-time>

    Date in which Portal Info was last updated

  • EmployerIdList array <string>

    List of Employer IDs

  • VisibilityIsGlobal boolean

    Global Visibility. True = Visible to the participant. False = Not visible to the participant.

  • VisibilityIsNone boolean

    No Visibility. True = Not visible to the participant. False = Visible to the participant.

  • TpaId string

    Unique id of the TPA

  • InfoKey integer <int32>

    Portal Info Key

  • InfoName string

    Portal Info Name

  • InfoDesc string

    Portal Info Description

  • InfoDate string <date-time>

    Portal Info Date

  • ExpireDate string <date-time>

    Portal Info Expiration Date

  • LastUpdateDate string <date-time>

    Date in which Portal Info was last updated

  • EmployerIdList array <string>

    List of Employer IDs

  • VisibilityIsGlobal boolean

    Global Visibility. True = Visible to the participant. False = Not visible to the participant.

  • VisibilityIsNone boolean

    No Visibility. True = Not visible to the participant. False = Visible to the participant.