Create an election

Submit an election against one eligible position of a voluntary
corporate action.

eligible_position_id must come from the eligible_positions array of
the offer identified by corporate_action_id. An account's electable
quantity is split across positions, each with its own limit, so the
position must be named explicitly rather than inferred.

Splitting a holding across more than one option means one election per
option. There is no atomic multi-election create, so the second call may
fail on a quantity constraint, a deadline or a rate limit and leave you
holding a partial instruction. Re-read the offer's eligible_positions
between calls, and be prepared to cancel the first.

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

An instruction to participate in an offer. corporate_action_id must match the offer that eligible_position_id belongs to; a mismatch is rejected with 422 position-event-mismatch.

string
required
length between 1 and 64

Clear Street's identifier for the corporate action.

string
required
length between 1 and 64

Identifier for one of the account's eligible positions in an offer. Obtained from eligible_positions on the corporate action, and required when creating an election.

Stable. The identifier survives the periodic re-capture of positions from the ledger: quantities are refreshed, identity is not. It is safe to persist and to reference in a later create. A new identifier appears only when a genuinely new position type opens in the offer.

When it stops resolving. Electing does not remove the position: the entry stays in eligible_positions with a reduced electable_quantity, reaching "0" and status: complete once you have elected all of it. The entry disappears only when the account no longer holds the security at all. A create against a position that is no longer one of the offer's positions for the account is rejected with 422 position-event-mismatch, or 404 eligible-position-not-found when the account has none left in the offer, so treat a persisted identifier as durable but not permanent, and re-read the offer if a later create rejects.

string
required
length between 1 and 16

The option's number within the offer. Treat as opaque and compare by equality — values are commonly zero-padded, and "001" and "1" are not interchangeable. Echo back exactly what was returned.

string
required
length ≤ 20
^[1-9][0-9]{0,19}$

Must not exceed the position's electable_quantity, must be at least the option's minimum_election_quantity, and the amount above that minimum must be a whole multiple of the option's election_quantity_multiplier.

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