v1

latestOpenAPI 3.0.32026-07-26870417.2 KB
queue

Purge Queue

This endpoint purges the jobs in the queue

If neither queue_id nor broadcast_id are provided in the request body, this will purge all the message jobs in the queues.

delete/queue/purge

Headers

x-phonestring
Example:{{orgPhone}}

Please provide the number of the phone you want to call with this API in the header. The number must be in country code + number format without any characters or spaces, e.g. 919876543210; Alternatively, provide the phone_id (phone-xxxxxxxxxxxx) in the header

Request body

broadcast_idstring

Provide the broadcast_id to purge all messages of that broadcast

Response

204 No Content

object required

204 No Content