Skip to main content
PATCH
Publish a vote collection

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.

Path Parameters

id
string
required

VoteCollection identifier

Body

application/merge-patch+json

The updated VoteCollection resource

name
string
description
string | null
owner
string<iri-reference>
Example:

"/api/v1/users/1"

votes
string<iri-reference>[]
Example:
timezone
string | null
dateStart
string<date-time> | null
dateEnd
string<date-time> | null
dateModified
string<date-time> | null
isActive
boolean
default:true
hasPreliminaryResults
boolean | null
default:false
isGeneral
boolean | null
hideVotersList
boolean | null
default:false
unit
string<iri-reference> | null
Example:

"/api/v1/units/1"

event
string<iri-reference> | null
Example:

"/api/v1/events/1"

Response

VoteCollection resource updated

id
integer
read-only
name
string
description
string | null
owner
object
votes
object[]
timezone
string | null
dateCreated
string<date-time>
read-only
dateStart
string<date-time> | null
dateEnd
string<date-time> | null
dateModified
string<date-time> | null
isActive
boolean
default:true
hasPreliminaryResults
boolean | null
default:false
isGeneral
boolean | null
isLocked
boolean | null
default:false
read-only
hideVotersList
boolean | null
default:false
isArchived
boolean | null
unit
object | null
event
object | null
totalVoted
string | null
default:0
totalEligible
string | null
default:0
isOpen
string | null
read-only
isFuture
string | null
read-only
isEditable
boolean | null
hasVoted
boolean | null
default:false
isVoteEligible
boolean | null
default:false
status
string | null
read-only
hasAvailableResults
string | null
read-only
participationPercentage
isDraft
boolean | null
default:true