Queue Management API
Overview
The Queue Management API is aimed at super-users who integrate Dux-Soup with their CRM or automation platform. It facilitates the inspection and management of queued activity.
Clear the Queue
Clear all queued messages.
- URL: https://app.dux-soup.com/xapi/remote/control/{{USERID}}/reset
- HTTP method: POST
- HTTP body: a JSON object with the required fields.
Queue Size
Get the number of messages waiting in the queue.
- URL: https://app.dux-soup.com/xapi/remote/control/{{USERID}}/queue/size
- HTTP method: GET
- There are 3 optional parameters: campaignid, profileid and command
- URL with all optional parameters: https://app.dux-soup.com/xapi/remote/control/{{USERID}}/queue/size?campaignid={{CAMPAIGNID}}&profileid={{PROFILEID}}&command={{COMMANDTYPE}}
Queued Items
Get a list of the current messages in the queue (max 100).
- URL: https://app.dux-soup.com/xapi/remote/control/{{USERID}}/queue/items
- HTTP method: GET
- There are 3 optional parameters: campaignid, profileid and command
- URL with all optional parameters: https://app.dux-soup.com/xapi/remote/control/{{USERID}}/queue/items?campaignid={{CAMPAIGNID}}&profileid={{PROFILEID}}&command={{COMMANDTYPE}}