Skip to main content
POST
Create a vote

Authorizations

Api-Token
string
header
required

Server-to-server authentication. Generate a token in the admin UI at Settings → Developers → API Access. Send the raw token in the Api-Token header — there is no Bearer prefix.

Tokens can be marked read-only at creation time, in which case the API rejects any non-GET request with 403 Forbidden.

Body

application/json

The new Vote resource

Vote Entity - Represents a question within a VoteCollection

A Vote is a single question in a voting session (VoteCollection). All session-level properties (dates, status, eligibility) come from VoteCollection.

title
string
required
type
enum<string>
default:single
Available options:
single,
multiple
voteCollection
string<iri-reference> | null
Example:

"/api/v1/vote_collections/1"

Response

Vote resource created

Vote Entity - Represents a question within a VoteCollection

A Vote is a single question in a voting session (VoteCollection). All session-level properties (dates, status, eligibility) come from VoteCollection.

title
string
required
id
integer
read-only
type
enum<string>
default:single
Available options:
single,
multiple
results
(string | null)[] | null
voteOptions
object[]