Update poll
Updates the given pollid.
Similar to create api except that it updates on the given poll id.
A poll can be updated even if you provide the mandatory parameters only. The default values for the optional parameters, if any, are then used.
All mandatory parameters are validated. Depending on the incorrect or missing data, error messages are generated. See Validations.
The response returns code 200 if the poll update was successful else error messages are generated. See Error codes.
The operation uses basic authentication.
Resource URL
PUT method on <ConfluenceBaseURL>/rest/polls/1.0/poll/{pollGuid}
ConfluenceBaseURL is the URL of your Confluence instance
Sample URL: http://localhost:1990/confluence/rest/polls/1.0/poll/f2945cb488a341198bb7ecf173f5db07
Parameters
See Parameters to learn more about the required and optional parameters of both choice and event polls.
name *
description
enddate
datePoll - false (true to create event poll)
nonUserVotesAllowed - false
pollAnonymous - false
votersVisible - true
resultsBeforeClosed - true
undoAllowed - true
multipleChoice - false
optionsExtendable - false
tinyUrlEnabled - false
percentsVisible - true (available for choice poll only)
voteCountVisible - true
options *
stringValue (* for choice poll & at least two values are required)
dateValue (* for event poll & at least one value is required)
Format to be used for options:
Choice poll | Event poll |
---|---|
|
|
Example request
{
"name": "Choice poll - What product do you like best?",
"description": "Choose the product you like most",
"datePoll": false,
"nonUserVotesAllowed": false,
"pollAnonymous": false,
"votersVisible": true,
"percentsVisible": true,
"votesCountVisible": true,
"resultsBeforeClosed": true,
"undoAllowed": true,
"multipleChoice": false,
"optionsExtendable": false,
"tinyUrlEnabled": false,
"options": [
{ "stringValue": "choice1" },
{ "stringValue": "choice2" }
],
"closedAt": "2022-03-19"
}
{
"name": "Event Poll- Select the meeting time for conference",
"description": "Choose the time for meeting ?",
"datePoll": true,
"multipleChoice": true,
"pollAnonymous": false,
"votersVisible": true,
"nonUserVotesAllowed": false,
"resultsBeforeClosed": true,
"undoAllowed": true,
"tinyUrlEnabled": false,
"optionsExtendable": false,
"options": [
{ "dateValue": "date1","stringValue":"1AM" },
{ "dateValue": "date2"}
],
"closedAt": "2022-03-19"
}
Example response
{
"result": "ok",
"guid": "7cf62f8135c1455888bf13e1dd125e5b",
"status": "200"
}
Validations
Validation condition | Validated parameter name(s) | Message | Requirement |
---|---|---|---|
If poll name is missing in the request payload | name |
| Poll name is mandatory to create polls. |
If options and its attributes are missing in the request payload |
|
|
|
Data validation |
|
|
Error codes
Code | Cause of error | Message displayed |
---|---|---|
412 | Validation errors as mentioned in the above table. See Validations. | |
403 | User is not permitted to perform a particular operation. | Operation failed with error not allowed. |
401 | Invalid user credentials. | Operation failed with error unauthorized. |