Closes the given Poll.

  • Closes the poll with the given poll id.

  • The response returns code 200 if the poll deletion was successful else error messages are generated. See Error codes.

The operation uses basic authentication.

Resource URL

POST Method on <ConfluenceBaseURL>/rest/polls/1.0/poll/{pollguid}/close

ConfluenceBaseURL is the URL of your Confluence instance.

Parameters

The url parameter should be replaced with guid of the poll.

  • pollguid - guid of the poll *

Example request URL

Sample request url for close

<ConfluenceBaseURL>/rest/polls/1.0/poll/ffb270e1aa0b4ba7bca4507503981efd/close

Example response

Sample response after successful execution of request

{
"result": "ok",
"guid": "ffb270e1aa0b4ba7bca4507503981efd",
"status": "200"
}

Error codes

Code

Cause of error

Message displayed

404

when poll with given poll guid in not found.

Operation failed with error poll not found

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.