Skip to main content
POST
Perform sweep action

Path Parameters

id
string<uuid>
required

Sweep ID

Body

application/json
action
enum<string>
required

Action to perform on sweep

Available options:
claim,
start,
checkout,
complete,
deliver,
decant
Example:

"start"

Response

Action performed successfully

success
boolean
required
sweep
unknown
error
string
message
string