AI Assistant

Participant APIs | REST

Version:

Download Open API Specification

Delete a document audience

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

Deletes a specified document audience identified by TPA ID and audience ID, effectively removing it from the system.

Path parameters

tpaId string Required

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

Document audience Id

Query parameters

refresh boolean

Indicates whether to return the updated list of document audiences after deletion (true) or an empty response (false).
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.

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>