Cancel an election

Cancel an election you have submitted, before Clear Street operations
has picked it up. is_cancelable on the election says whether this
will succeed. This is not a withdrawal request — once an election
reaches ops-submitted, cancelling is no longer available and
createElectionWithdrawal is the route.

The election is not removed. It remains readable with
status: client-canceled and continues to appear in list responses.

Safe to repeat. Cancelling an election that is already
client-canceled returns 200 with the record and changes nothing, so
a retry after a timeout is harmless.

Once Clear Street operations locks the election this returns
409 election-locked. What to do next depends on how far it has got:
at ops-submitted a withdrawal request is the way back, but at
ops-in-progress nothing is available yet and you must wait for the
election either to be submitted or to be released at end of day.
can_withdraw on the election distinguishes the two.

An election in any other terminal state — ops-allocated-paid,
rejected, client-withdrew — returns 409 election-not-cancelable.
That is a different problem from election-locked: nothing is in
progress, the election is simply finished.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length between 1 and 256

The account ID or account number.

string
required
length between 1 and 64

The election ID. A value that is not a positive whole number is rejected with 400.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Choose an example:
application/json
application/problem+json