Skip to main content
POST
Create participant

Authorizations

Authorization
string
header
required

Personal API token — find yours under My Account → API.

Headers

X-POLLUNIT-USER-IDENTIFIER
string

Your own identification of the user on whose behalf the request is made, any string. The user identifiers should not be guessable and stay secret, otherwise users could get access to other users' contents. Only used with a public API token: the created or changed object belongs to that anonymous user instead of the token owner, which keeps the user in control of it in later requests with the same identifier.

X-POLLUNIT-POLL-PASSWORD
string

Access password of the poll. Only needed for password protected polls.

Path Parameters

poll_id
string
required

Poll member_hash or admin_hash

Query Parameters

organization_id
string

public_id of an organization the user belongs to. When given, the request runs in that organization context instead of the personal account.

Body

application/json
voter
object
required

Attributes accepted when creating a participant. The fields the poll configuration makes mandatory are listed in the poll show response as voter_required_fields.

Response

voting fee has to be paid

Returned instead of the participant when the poll charges a voting fee or asks for a donation. The participant already exists but stays unpaid until the payment page has been completed.

message
string
Example:

"Complete payment for voter"

url
string<uri>

Payment page for this participant.