Skip to main content
PATCH
Update Voting Session

Authorizations

Authorization
string
header
required

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

Headers

authorization
string | null
X-API-Key
string | null

Path Parameters

experiment_id
string<uuid>
required
session_id
string<uuid>
required

Body

application/json

Update a voting session (owner only).

expires_in_hours
integer | null

Reset expiry relative to now. Explicit null means no expiry.

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

Instructions shown to voters on this voting link. Explicit null means no instructions.

Maximum string length: 4000
is_active
boolean | null

Pause or resume the voting link.

max_seats
integer | null

New max seats (must be >= active seats). Explicit null means unlimited.

Required range: x >= 1
max_votes_per_voter
integer | null

New max votes per seat. Explicit null means unlimited.

Required range: x >= 1
spend_cap_credits
integer | null

New spend cap in credits. Explicit null means unlimited.

Required range: x >= 1
total_vote_limit
integer | null

New total counted vote limit. Explicit null means 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