# Remove every participant from an order

```http
PATCH https://secure.yoprint.com/v1/api/store/{team_slug}/sales_order/{hash_id}/participant/clear
```

- API version: v1
- Operation ID: `v1_public_sales_order_participant_clear`
- Section: Sales › [Sales order messages](https://developer.yoprint.com/reference/sales-order-messages.md)
- Web page: https://developer.yoprint.com/reference/sales-order-messages/v1-sales-order-participant-clear/
- Authentication: `Authorization: Bearer YOUR_API_KEY`

Removes all participants of a sales order. A quote answers 404: this operation looks the order up among sales orders only. Messages already sent keep their recipients. The answer has no data. `{hash_id}` is the order's `id` (for example `V4keXwwxMQyXw7`); the `ord_` unique key is not accepted here.

## Permission

Any member of the team.

## Business rules

- Sales orders only: a quote's id answers 404.

## Side effects

- A later message that names a removed participant is refused with 422 `participant_not_on_record`. Add participants again, and use their new ids, before sending.

## Path parameters

- `team_slug` (string, required): Your team slug, shown as Team ID next to your API key in Profile. Example `your-team`.
- `hash_id` (string, required): The sales order's `id` (a hash id). A quote's id answers 404 here. The `ord_` unique key and the order number do not work. Example `V4keXwwxMQyXw7`.

## Request body

This operation takes no request body.

### Example request

```bash
curl -X PATCH 'https://secure.yoprint.com/v1/api/store/your-team/sales_order/V4keXwwxMQyXw7/participant/clear' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'X-Yoprint-Decimal-Format: exact-v1'
```

## Response

`200` Successful response.

Fields:

- `data` (null, required): No data.
- `status` (integer, required)
- `success` (boolean, required)

Example response:

```json
{
  "data": null,
  "status": 200,
  "success": true
}
```

## Errors

- `401` The API key is missing or wrong (`unauthenticated`).
- `403` You are not allowed to do this. `api_access_not_in_plan`: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only `{"message": "Insufficient Permission"}`. Other refusals use the error envelope, with `unauthorized` or `user_is_not_authorized`.
- `404` Not found. `page_not_found`: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. `code: null`, with a message that starts "No query results for": there is no record with that id.
  - When: No such sales order in this team, or the id is a quote's. Fix: Check the id. A quote's participants can't be cleared here.

## Related

- [Add a participant to an order](https://developer.yoprint.com/reference/sales-order-messages/v1-sales-order-participant-store.md): `POST /v1/api/store/{team_slug}/sales_order/{hash_id}/participant`