Participant APIs | REST

Version:

Download Open API Specification

Delete a document audience

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

Delete a document audience

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.
audienceId string Required

Document audience Id

Query parameters

refresh boolean

True: return the list of document audience after deletion, False: return empty after deletion.
decrypt integer <int32>

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

Response

array <object>
- 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>