---
title: "Deleted Participant Document"
method: POST
path: "/api/v2/retool/participants/participant-files/delete"
tags: ["v2", "Participants", "Platform Files"]
---

# Deleted Participant Document

`POST /api/v2/retool/participants/participant-files/delete`

## Request

- Base URL: `https://api.caresquare.com.au` (the document declares no server; this is the origin it was published from)
- URL: `https://api.caresquare.com.au/api/v2/retool/participants/participant-files/delete`
- Auth: none declared

Deletes the participants document entry

Returns ParticipantsFileDeleteResult

Requestor must have authority to access (be the partipants assigned plan_manager)

IF participant document is a platform_file type:
    - Delete platform file (as per hard_delete choice)
    If an exception occurs, the participant document will not be removed

## Query parameters

- `participant_id` string, uuid, required
- `participant_document_id` integer, required
- `hard_delete` boolean

## Response `200`

Successful Response

- ApiResponseJSON: Standardised JSON Api Response To conforms to Aus Gov recommended format [api.gov.au](https://api.gov.au/sections/api-response.html#response-payload) Which is a modification of [JSON:API]( https://jsonapi.org/format/#introduction) data meta: meta object that contains non-standard meta-information messages: container for informational and warning messages related to the transaction. Not Implemented (not currently required): Links: [HATEOS Links](https://api.gov.au/sections/api-response.html#response-payload)
  - `data` unknown[]: List of items returned in the response following given criteria
    - unknown
  - `meta` ApiResponseMeta: Standardised Api Response Meta Not always required (except for example; with paginated results) Future: Could provide base that includes org information, copy-write etc
    - `processing_time_ms` integer, nullable
    - `total_records` integer, nullable
    - `page` integer, nullable
    - `limit` integer, nullable
    - `count` integer, nullable
    - `cursor` unknown
    - `cursor_last` unknown
    - `more_data_available` boolean, nullable
  - `messages` ApiResponseMessage[], nullable: Response Messages
    - `message_type` 'debug' | 'info' | 'warning' | 'error', required
    - `message` string, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/caresquare/apis/caresquare-api.md) - [All operations](https://skmtc.dev/caresquare/apis/caresquare-api/llms.txt) - [OpenAPI document](https://skmtc.dev/caresquare/apis/caresquare-api/revisions/d428fe38bf62?raw)