Skip to main content
POST
Create Voting Session

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string | null
Maximum string length: 255
authorization
string | null
X-API-Key
string | null

Path Parameters

experiment_id
string<uuid>
required

Body

application/json

Request to create a voting session.

audience
enum<string>
default:public

public links allow anonymous voters; internal links require authenticated vote permission

Available options:
public,
internal
expires_in_hours
integer | null
default:168

Hours until link expires (defaults to 7 days)

Required range: 1 <= x <= 8760
instructions
string | null

Optional instructions shown to anonymous participants

Maximum string length: 4000
max_seats
integer | null

Participant limit (null = unlimited)

Required range: x >= 1
max_votes_per_voter
integer | null

Votes per participant limit (null = unlimited)

Required range: x >= 1
name
string | null

Optional name (auto-generated if not provided)

Maximum string length: 255
spend_cap_credits
integer | null

Spend cap in credits for this voting link (null = unlimited). Preferred over total_vote_limit.

Required range: x >= 1
total_vote_limit
integer | null

Counted vote limit for this voting link (null = unlimited)

Required range: x >= 1

Response

Successful Response

Response for a voting session.

created_at
string<date-time>
required
created_by
string<uuid>
required
experiment_id
string<uuid>
required
expires_at
string<date-time> | null
required
id
string<uuid>
required
is_active
boolean
required
max_seats
integer | null
required
max_votes_per_voter
integer | null
required
name
string
required
revoked_at
string<date-time> | null
required
token
string
required
total_votes
integer
required
unique_voters
integer
required
voting_url
string
required
audience
enum<string>
default:public
Available options:
public,
internal
instructions
string | null
is_canonical_internal
boolean
default:false
non_choice_responses
integer
default:0
paused_at
string<date-time> | null
spend_cap_credits
integer | null
spend_spent_credits
integer
default:0
spend_used
integer
default:0
status
string
default:active
total_vote_limit
integer | null