Participant APIs | REST

Selected Version:
Download Open API File

Delete a list of document categories.

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

This endpoint allows you to delete specified document categories associated with a given TPA ID. It is typically used when document categories are no longer needed or require removal for organizational purposes.

Request

  • tpaId string Required

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

  • refresh boolean

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

  • array <object>
    • TpaId string
    • CategoryKey integer <int32>
  • array <object>
    • TpaId string
    • CategoryKey integer <int32>

Response

  • array <object>
    • TpaId string
    • CategoryKey integer <int32>
    • CategoryId string
    • CategoryName string
    • DisplayOrder integer <int32>
    • LastUpdateDate string <date-time>
  • array <object>
    • TpaId string
    • CategoryKey integer <int32>
    • CategoryId string
    • CategoryName string
    • DisplayOrder integer <int32>
    • LastUpdateDate string <date-time>
Response Headers
No response yet.
Response Body
No response yet.

AI Assistant Preview

Generating response...