Skip to main content
DELETE
/
instances
/
{instanceId}
/
token
/
{token}
/
queue
Delete queue
curl --request DELETE \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/queue \
  --header 'Client-Token: <api-key>'

Overview

This method is responsible for deleting all messages in your queue awaiting processing.

Attributes

instanceId
string
required
Your instance ID. Available in the Z-API panel under Instances.
token
string
required
Your Z-API instance token.

Response

200

Queue deleted successfully.

405

Make sure you are correctly sending the method specification, that is, verify that you sent DELETE as specified at the beginning of this topic.

415

If you receive a 415 error, make sure to add the “Content-Type” header to your request, which in most cases is “application/json”.