Loading ...

REST API: Submit Survey Votes | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Content » REST API: Polls and Surveys » REST API: Submit Survey Votes
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 21

REST API: Submit Survey Votes

0 
 /5
0 (0votes)
Open API Guide
POST/api/surveys/{SurveyID}/votes

Submit votes for a specified survey.

Request

Request Header

HeaderRequiredValueDescription
AuthorizationYESBearer YOUR_TOKENBearer token for the authenticated user. Learn how to create Bearer tokens.
Content-TypeYESapplication/jsonMust be set to application/json

Required Parameters

ParameterTypeRequiredLocationDescription
Votes JSONStringYESBodyThis is JSON that represents a vote object that you're creating. This should be of the format seen below in the sample given. The required values in this JSON are given below.
QuestionIDIntegerYESBodyThe unique identifier for the question
ChoiceIDIntegerYESBodyThe unique identifier for the selected choice
CheckBoxChoiceCSVStringYESBodyA list of selected choices for checkbox questions
TextBoxChoiceTextStringYESBodyThe text input provided for text box questions

Optional Parameters

ParameterTypeRequiredLocationDescription
LogViewBooleanNOQueryLogs the API call as an action in User Activity when set to true

Example

Request Header

Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

Request URL

https://your-site.com/api/surveys/145/votes

Request Body

[
  {
    "QuestionID": 168,
    "ChoiceID": 353
  },
  {
    "QuestionID": 170,
    "CheckBoxChoiceCsv": "355,356"
  },
  {
    "QuestionID": 169,
    "TextBoxChoiceText": "Mobile App"
  }
]

Success Response

{
  "IsError": false,
  "ResponseMessage": "Successfully submitted the survey."
}

Error Response

{
  "IsError": true,
  "ResponseMessage": "Required parameter is missing or invalid.",
  "ResponseData": null
}

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestOne or more required fields are missing or invalid. (surveyID, votes)Verify the request payload against the required parameters.
401 UnauthorizedMissing or invalid Bearer token.Check token validity. Learn how to create Bearer tokens →
403 ForbiddenUser does not have sufficient permissions.Confirm the user has the required roles for this action.
404 Not FoundThe specified poll or survey was not found.Verify the pollID is correct.
500 Server ErrorInternal failure.Retry later.

Rate Limits

While Axero does not enforce hard rate limits by default, we recommend the following best practices to ensure optimal performance:

  • Sustained Request Rate: Do not exceed 5 API calls per second
  • Sequential Processing: Wait for each request to complete before sending the next in automated workflows
  • Concurrent Connections: If parallel processing is required, limit to 3 or fewer simultaneous requests
  • Response Timeout: Ensure API responses complete within 15 seconds during testing

Axero may implement temporary rate restrictions if excessive API usage affects overall site performance. For high-volume integrations, contact Axero to discuss your requirements.

Wiki Index

Pages