Start Poll

Start or continue a poll.

POST /cabinet/polls/{response_id}/start

Start Poll

cURL

curl --request POST \
  --url https://api.example.com/cabinet/polls/{response_id}/start \
  --header 'Authorization: Bearer <token>'

200

{
  "response_id": 123,
  "current_question_index": 123,
  "total_questions": 123,
  "question": {
    "id": 123,
    "text": "<string>",
    "order": 123,
    "options": [
      {
        "id": 123,
        "text": "<string>",
        "order": 123
      }
    ]
  }
}

Authorizations

Authorization · string · header · required

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

Path Parameters

response_id · integer · required

Response

200

application/json

Successful Response

Response when starting a poll.

response_id · integer · required

current_question_index · integer · required

total_questions · integer · required

question · PollQuestionResponse · object · required

Poll question with options.

Show child attributes