Delete a list of document audiences

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

This endpoint allows you to delete specified document audiences associated with a unique TPA identifier. It is typically used to manage and remove audiences that are no longer needed or relevant.

Request

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.

Query parameters

refresh boolean

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

array <object>
- TpaId string
- AudienceKey integer <int32>

array <object>
- TpaId string
- AudienceKey integer <int32>

Response

Response body

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>

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>

Request URL

Authorization Bearer Token

tpaId (Required)

refresh

decrypt

Content Type

Request body (optional)

No response yet.

No response yet.

Participant APIs | REST