Update a document audience

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

Update the audience settings for a specific document identified by the TPA ID. This operation is used to modify the audience parameters, such as which employers or divisions can access the document.

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 document audience after saving. Set to true to receive the updated audience details; false will return an empty response.
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.

Request body

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

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>