# Clear a queue's waiting records

> Every record waiting in the queue is removed and never reaches the consumer workflow. The queue itself stays.

Source: https://docs.stacksync.com/api-reference/queues/clear_queue_records

`DELETE https://api.stacksync.com/v1/workspaces/{workspace_id}/queues/{workflows_app_queue_id}/records`

- Operation: `clear_queue_records`
- Resource: Queues
- Access: writes data

## Authentication

- `Authorization: Bearer <key>`: A workspace API key (workspace_…, created by a workspace owner under Workspace settings > Stacksync API) acts with editor rights on that workspace only; a user API key (user_…, created under Profile > Stacksync API) acts as that user in every workspace they belong to. POST, PUT and PATCH requests must send Content-Type: application/json. Every authentication failure answers 403.

## Path parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `workspace_id` | integer | Yes | The workspace. List the ones your key can reach with GET /v1/workspaces. |
| `workflows_app_queue_id` | string (uuid) | Yes | The queue. |

## Query parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `region` | string (besg \| usnv) | Yes | Region of the resource: besg (Europe) or usnv (United States), as GET /v1/regions lists them |

## Returns

### 200 OK

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `queue_id` | string | Yes |  |

## Example request

```bash
curl -X DELETE "https://api.stacksync.com/v1/workspaces/{workspace_id}/queues/{workflows_app_queue_id}/records?region=besg" \
  -H "Authorization: Bearer $STACKSYNC_API_KEY"
```

## Example response (200)

```json
{
  "queue_id": "<queue_id>"
}
```

## Errors

| Status | Meaning | Body |
| --- | --- | --- |
| 400 | Bad Request | `{ "error": string, "msg": string, "field": string \| null }` |
| 403 | Forbidden | `{ "error": string, "msg": string, "field": string \| null }` |
| 404 | Not Found | `{ "error": string, "msg": string, "field": string \| null }` |
| 409 | Conflict | `{ "error": string, "msg": string, "field": string \| null }` |

## Related

- [API Reference overview](https://docs.stacksync.com/api-reference): base URLs, regions, pagination, idempotency and errors
- [Authentication](https://docs.stacksync.com/api-reference/authentication): API keys and the 403 answers
- OpenAPI document: https://docs.stacksync.com/openapi.json
- [List queues](https://docs.stacksync.com/api-reference/queues/list_queues)
- [List a queue's waiting records](https://docs.stacksync.com/api-reference/queues/list_queue_records)
- [Get a queue](https://docs.stacksync.com/api-reference/queues/get_queue)
- [Create a queue](https://docs.stacksync.com/api-reference/queues/create_queue)
- [Update a queue](https://docs.stacksync.com/api-reference/queues/update_queue)
- [Delete a queue](https://docs.stacksync.com/api-reference/queues/delete_queue)
- [Flush a queue](https://docs.stacksync.com/api-reference/queues/flush_queue)