Queue APIs
Purge Queue
This endpoint purges the jobs in the queue
Request Params
-
queue_id
(string, optional)- Provide the queue_id of the message to purge only that job
-
broadcast_id
(string, optional)- Provide the broadcast_id to purge all messages of that broadcast
If no params are provided, this will purge all the message jobs in the queue
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
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
Query Parameters
Provide the queue_id of the message to purge only that job
Provide the broadcast_id to purge all messages of that broadcast
Body
application/json · any
The body is of type any
.
Response
200 - application/json
204 No Content
Was this page helpful?