Update a document

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

Update the details of a specific document identified by its TPA ID. This operation is used to modify existing document information, such as name, description, and associated files.

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 after saving (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.

Request body

TpaId string
DocumentId string
DocumentName string
Description string
DocumentPostDate string <date-time>
ExpireDate string <date-time>
CategoryId string
AudienceId string
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
Employers array <object>
- TpaId string
- EmprId string
- EmprName string
LastUpdateDate string <date-time>
LegacyDocumentKey integer <int32>
AssignedOption enum<string>

Possible values: None Hidden AllEmployer SelectedEmployer DocumentAudience All

Response

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