Skip to content

Close a poll

POST
/api/v1/polls/{pollId}/close
curl --request POST \
--url http://localhost:3001/api/v1/polls/example/close \
--header 'Authorization: <Authorization>'

Close an open poll so it no longer accepts votes. Creator/admin only.

pollId
required
string

Poll ID

OK

Media typeapplication/json
object
key
additional properties
any
Examplegenerated
{}

Unauthorized

Media typeapplication/json
object
error
string
success
boolean
Examplegenerated
{
"error": "example",
"success": true
}

Forbidden

Media typeapplication/json
object
error
string
success
boolean
Examplegenerated
{
"error": "example",
"success": true
}

Not Found

Media typeapplication/json
object
error
string
success
boolean
Examplegenerated
{
"error": "example",
"success": true
}

Internal Server Error

Media typeapplication/json
object
error
string
success
boolean
Examplegenerated
{
"error": "example",
"success": true
}