Skip to main content
POST
Submit elections

Authorizations

Authorization
string
header
required

Partner API key. psk_test_<32 hex> for test mode, psk_live_<32 hex> for live mode. Store them in your secrets manager on issue. Live keys are shown once; the scoped partner portal can show an active sandbox key again.

Headers

Idempotency-Key
string

Any non-empty string; deterministic keys from your own IDs work best. Repeating the same key with the same body on the same endpoint and mode within 24 hours returns the stored successful response (with Idempotent-Replay: true) instead of re-executing. Error responses are not stored.

Path Parameters

groupId
string
required

Group ID, e.g. grp_8c2f41d09a3e.

Pattern: ^grp_[0-9a-f]{12}$

Body

application/json
elections
object[]
required
Required array length: 1 - 10000 elements

Response

Elections processed.

groupId
string
required
received
integer
required
accepted
integer
required
enrolled
integer
required
waived
integer
required
invited
integer
required

Member login emails sent. None are sent in test mode.

invitesSuppressed
enum<string> | null
required
Available options:
test-mode,
null
deductionsWebhook
boolean
required

Whether a deductions.changed event was sent.

errors
object[]
required