Request an election withdrawal

Request that all or part of a submitted election be withdrawn.

This is a request, not an instruction. It is created with
status: requested and is subject to approval by Clear Street
operations, which may reject it — the transfer agent may already have
acted on the election.

Set scope to full to withdraw the whole election, or to partial
and supply quantity to withdraw part of it. Exactly one of those two
shapes is accepted; there is no default.

Preconditions, all of which are published on the resources themselves:

  • the offer permits withdrawals (withdrawals_permitted on the offer);
  • the election has reached ops-submitted (can_withdraw on the
    election);
  • no earlier withdrawal on the same election is still open;
  • for a partial, quantity is a whole number no greater than the
    election's remaining_quantity.

A partial whose quantity equals remaining_quantity withdraws the whole
election, so it is recorded as scope: full and, once approved, moves
the election to client-withdrew. A larger quantity is rejected with
422 quantity-exceeds-election.

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.

Body Params

scope decides the shape of the rest of the body: partial requires quantity, full requires that it be absent. Supplying quantity with scope: full, or omitting it with scope: partial, is rejected with validation-error.

string
required
length between 1 and 64
string
enum
required

How much of the election to withdraw. Required — there is no default.

  • full: withdraw the whole election. quantity must be omitted. On
    approval the election moves to client-withdrew.
  • partial: withdraw part of it. quantity is required and must not
    exceed the election's remaining_quantity. On approval the
    election's remaining_quantity falls and its status is unchanged.
    A quantity equal to remaining_quantity is recorded as full.
Allowed:
string
length ≤ 20
^[1-9][0-9]{0,19}$

The quantity to withdraw. Required when scope is partial, and must be a whole number no greater than the election's remaining_quantity; a greater value is rejected with quantity-exceeds-election. A value equal to remaining_quantity is recorded as scope: full. Must be absent when scope is full.

string
required
length between 1 and 256

An ID that you provide, unique per account per resource type. Stored, echoed back, and used as the idempotency key. See the Idempotency section for replay, conflict and retention semantics.

string
length ≤ 4000
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