Participant APIs | REST

Selected Version:
Download Open API File

Add a new document audience

https://api.wealthcare.com/participant/services/document/management/audience/{tpaId}

This endpoint allows you to create a new document audience associated with a specific TPA ID. It is used to manage the visibility and distribution of documents to designated audience members.

Request

Path parameters

Path parameters page anchor
  • tpaId string Required

    A unique identifier used to identify your admin instance. This value is system generated when the admin instance was created.

Query parameters

Query parameters page anchor
  • refresh boolean

    Indicates whether to return the document audience after it has been saved. Set to true to receive the audience details; false will return an empty response.

  • 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.

Request body

Request body page anchor
  • TpaId string
  • AudienceKey integer <int32>
  • AudienceId string
  • AudienceName string
  • AudienceMembers object
    • TpaId string
    • Employers array <object>
      • TpaId string
      • EmprId string
      • EmprName string
    • Divisions array <object>
      • TpaId string
      • EmprId string
      • EmprName string
      • DivisionKey integer <int32>
      • DivisionName string
    • Subgroups array <object>
      • TpaId string
      • EmprId string
      • EmprName string
      • SubGroupKey integer <int32>
      • SubgroupName string
    • AcctTypes array <object>
      • TpaId string
      • AcctTypeCde string
      • AcctTypeDesc string
      • AcctTypeClass enum<string>
        Possible values: FSA HRA HSA Deductible Other VEBA Transit Parking Retiree
      • AcctTypeClassDesc string
    • HideSubgroup boolean
  • AudienceOptions enum<string>
    Possible values: None AllEmployer AllDivision AllSubgroup AllAcctType EmptyEmployer EmptyDivision EmptySubgroup EmptyAcctType
  • LastUpdateDate string <date-time>
  • TpaId string
  • AudienceKey integer <int32>
  • AudienceId string
  • AudienceName string
  • AudienceMembers object
    • TpaId string
    • Employers array <object>
      • TpaId string
      • EmprId string
      • EmprName string
    • Divisions array <object>
      • TpaId string
      • EmprId string
      • EmprName string
      • DivisionKey integer <int32>
      • DivisionName string
    • Subgroups array <object>
      • TpaId string
      • EmprId string
      • EmprName string
      • SubGroupKey integer <int32>
      • SubgroupName string
    • AcctTypes array <object>
      • TpaId string
      • AcctTypeCde string
      • AcctTypeDesc string
      • AcctTypeClass enum<string>
        Possible values: FSA HRA HSA Deductible Other VEBA Transit Parking Retiree
      • AcctTypeClassDesc string
    • HideSubgroup boolean
  • AudienceOptions enum<string>
    Possible values: None AllEmployer AllDivision AllSubgroup AllAcctType EmptyEmployer EmptyDivision EmptySubgroup EmptyAcctType
  • LastUpdateDate string <date-time>

Response

Response body

Response body page anchor
  • TpaId string
  • AudienceKey integer <int32>
  • AudienceId string
  • AudienceName string
  • AudienceMembers object
    • TpaId string
    • Employers array <object>
      • TpaId string
      • EmprId string
      • EmprName string
    • Divisions array <object>
      • TpaId string
      • EmprId string
      • EmprName string
      • DivisionKey integer <int32>
      • DivisionName string
    • Subgroups array <object>
      • TpaId string
      • EmprId string
      • EmprName string
      • SubGroupKey integer <int32>
      • SubgroupName string
    • AcctTypes array <object>
      • TpaId string
      • AcctTypeCde string
      • AcctTypeDesc string
      • AcctTypeClass enum<string>
        Possible values: FSA HRA HSA Deductible Other VEBA Transit Parking Retiree
      • AcctTypeClassDesc string
    • HideSubgroup boolean
  • AudienceOptions enum<string>
    Possible values: None AllEmployer AllDivision AllSubgroup AllAcctType EmptyEmployer EmptyDivision EmptySubgroup EmptyAcctType
  • LastUpdateDate string <date-time>
  • TpaId string
  • AudienceKey integer <int32>
  • AudienceId string
  • AudienceName string
  • AudienceMembers object
    • TpaId string
    • Employers array <object>
      • TpaId string
      • EmprId string
      • EmprName string
    • Divisions array <object>
      • TpaId string
      • EmprId string
      • EmprName string
      • DivisionKey integer <int32>
      • DivisionName string
    • Subgroups array <object>
      • TpaId string
      • EmprId string
      • EmprName string
      • SubGroupKey integer <int32>
      • SubgroupName string
    • AcctTypes array <object>
      • TpaId string
      • AcctTypeCde string
      • AcctTypeDesc string
      • AcctTypeClass enum<string>
        Possible values: FSA HRA HSA Deductible Other VEBA Transit Parking Retiree
      • AcctTypeClassDesc string
    • HideSubgroup boolean
  • AudienceOptions enum<string>
    Possible values: None AllEmployer AllDivision AllSubgroup AllAcctType EmptyEmployer EmptyDivision EmptySubgroup EmptyAcctType
  • LastUpdateDate string <date-time>
Response Headers 
No response yet.
Response Body 
No response yet.

Copyright © 2026 Alegeus Technologies, LLC. All rights reserved. Alegeus, Alegeus Technologies, WealthCare, WealthCare Saver are registered trademarks of Alegeus Technologies, LLC

AI Assistant Preview

Generating response...