Delete a list of documents

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

This endpoint allows you to delete a specified list of documents associated with a particular TPA ID. It is typically used when documents are no longer needed or need to be removed for compliance or organizational purposes.

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 documents 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 and 0 for decrypted; defaults to 0 if not specified.

Response

array <object>
- DocumentKey integer <int32>
- TpaId string
- DocumentId string
- DocumentName string
- Description string
- DocumentPostDate string <date-time>
- ExpireDate string <date-time>
- CategoryId string
- CategoryName string
- DisplayOrder integer <int32>
- AudienceId string
- AudienceName string
- DocumentFileKey integer <int32>
- FileDetails object
  - DocumentFileKey integer <int32>
  - ContentLength integer <int32>
  - ContentType string
  - FileName string
  - InputStream string <byte>
  - Base64 string
  - FileFormat enum<string>
    
    Possible values: All Unknown Fixed Csv Xml Pdf Qif Excel Jpeg Gif Bmp FixedNacha Delimited Word Png Tiff ExtFileFormat
- LastUpdateDate string <date-time>
- Employers array <object>
  - TpaId string
  - EmprId string
  - EmprName string
- isLegacyDocument boolean
- AssignedOption enum<string>
  
  Possible values: None Hidden AllEmployer SelectedEmployer DocumentAudience All