> ## Documentation Index > Fetch the complete documentation index at: https://docs.periskope.app/llms.txt > Use this file to discover all available pages before exploring further. # Purge Message Queues > Removes unsubmitted jobs from the send queue of the phone, by queue_ids or broadcast_id. Warning: an empty body purges the entire queue. ## OpenAPI ````yaml api-reference/openapi-generated.json POST /v1/message/queues/purge openapi: 3.0.3 info: title: Periskope API version: 1.0.0 description: >- Periskope external API. Responses use a flat, unwrapped shape: most endpoints return the resource at the top level, and list endpoints return a wrapper object with pagination inline (e.g. `{ from, to, count, chats: [...] }`). The documented response schemas describe these shapes directly. servers: - url: https://api.periskope.app security: - bearerAuth: [] paths: /v1/message/queues/purge: post: tags: - Messages summary: Purge message queue jobs description: >- Removes unsubmitted jobs from the send queue of the phone, by queue_ids or broadcast_id. Warning: an empty body purges the entire queue. operationId: purgeMessageQueues parameters: - schema: type: string minLength: 1 example: '919876543210' description: >- Phone to act with: country code + number without symbols or spaces (e.g. 911111111111), or a phone_id (phone-xxxxxxxxxxxx). The phone must be connected to the org and accessible by the API token. required: true description: >- Phone to act with: country code + number without symbols or spaces (e.g. 911111111111), or a phone_id (phone-xxxxxxxxxxxx). The phone must be connected to the org and accessible by the API token. name: x-phone in: header requestBody: content: application/json: schema: type: object properties: queue_ids: type: array items: type: string description: Queue job ids to remove from the queue example: - 00000000-0000-0000-0000-000000000000 broadcast_id: type: string description: Remove every queued job belonging to this broadcast example: 00000000-0000-0000-0000-000000000000 responses: '200': description: Confirmation of the purge content: application/json: schema: type: object properties: purged: type: boolean enum: - true description: Always true when the purge request was accepted mode: type: string enum: - all - queue_ids - broadcast description: >- What was purged: 'queue_ids' when specific jobs were targeted, 'broadcast' when a broadcast's jobs were targeted, 'all' when neither filter was given and the entire queue was purged example: queue_ids queue_ids: type: array items: type: string description: >- Echo of the queue_ids filter, present only when it was sent example: - 00000000-0000-0000-0000-000000000000 broadcast_id: type: string description: >- Echo of the broadcast_id filter, present only when it was sent examples: default: summary: Response body value: purged: true mode: queue_ids queue_ids: - 00000000-0000-0000-0000-000000000000 broadcast_id: null '400': description: The phone is off or its server is unreachable content: application/json: examples: error: summary: The phone is off or its server is unreachable value: code: ERROR message: The phone is off or its server is unreachable status: 400 schema: type: object properties: code: type: string example: ERROR message: type: string example: The phone is off or its server is unreachable status: type: integer example: 400 example: code: ERROR message: The phone is off or its server is unreachable status: 400 '401': description: Invalid, expired or missing API token content: application/json: examples: error: summary: Invalid, expired or missing API token value: code: UNAUTHORIZED_ERROR message: Invalid bearer auth token status: 401 schema: type: object properties: code: type: string example: UNAUTHORIZED_ERROR message: type: string example: Invalid bearer auth token status: type: integer example: 401 example: code: UNAUTHORIZED_ERROR message: Invalid bearer auth token status: 401 '422': description: Request validation failed content: application/json: examples: error: summary: Request validation failed value: code: VALIDATION_ERROR message: Request validation failed status: 422 fields: body.chat_id: message: chat_id is required schema: type: object properties: code: type: string example: VALIDATION_ERROR message: type: string example: Request validation failed status: type: integer example: 422 fields: type: object additionalProperties: type: object properties: message: type: string value: {} example: body.chat_id: message: chat_id is required example: code: VALIDATION_ERROR message: Request validation failed status: 422 fields: body.chat_id: message: chat_id is required '429': description: Rate limit exceeded content: application/json: examples: error: summary: Rate limit exceeded value: code: RATE_LIMIT_ERROR message: You can only make 100 requests per second status: 429 schema: type: object properties: code: type: string example: RATE_LIMIT_ERROR message: type: string example: You can only make 100 requests per second status: type: integer example: 429 example: code: RATE_LIMIT_ERROR message: You can only make 100 requests per second status: 429 '500': description: Internal server error content: application/json: examples: error: summary: Internal server error value: code: UNKNOWN_ERROR message: Internal server error status: 500 schema: type: object properties: code: type: string example: UNKNOWN_ERROR message: type: string example: Internal server error status: type: integer example: 500 example: code: UNKNOWN_ERROR message: Internal server error status: 500 security: - bearerAuth: [] x-codeSamples: - lang: typescript label: TypeScript source: |- import { PeriskopeApi } from '@periskope/periskope-client'; const client = new PeriskopeApi({ authToken: 'YOUR_API_KEY', phone: '919876543210', // the phone to act with (x-phone) }); async function main() { const response = await client.messages.purgeMessageQueues({ queue_ids: [ '00000000-0000-0000-0000-000000000000', ], }); console.log(response); } main(); - lang: bash label: cURL source: |- curl -X POST 'https://api.periskope.app/v1/message/queues/purge' \ -H 'Authorization: Bearer YOUR_API_KEY' \ -H 'x-phone: 919876543210' \ -H 'Content-Type: application/json' \ -d '{ "queue_ids": [ "00000000-0000-0000-0000-000000000000" ] }' components: securitySchemes: bearerAuth: type: http scheme: bearer description: >- Your Periskope API token, sent as `Authorization: Bearer `. Generate one from the Periskope dashboard under **Settings → API & Webhooks**. API access requires an active Pro or Enterprise plan. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.