Dispatches
Populate Dispatch Queue
Dispatches
Populate Dispatch Queue
Populates the dispatch queue for a given dispatch, taking into account inclusion and exclusion lists.
POST
/
dispatches
/
{id}
/
populate-queue
POST /dispatches//populate-queue
This endpoint populates the dispatch queue for a given dispatch. It clears any existing queue for the dispatch and then repopulates it based on the contact lists associated with the dispatch. It respects inclusion and exclusion rules, ensuring that only unique, intended contacts are queued for dispatch.
Path Parameters
id
string
requiredThe ID of the dispatch to populate.
Responses
200 - OK
object
400 - Bad Request
object
404 - Not Found
object
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
id
string
requiredThe ID of the dispatch to populate.
Was this page helpful?