Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Deletes a poll.

  • Deletes the poll using the provided poll ID.

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

Note

The operation uses basic authentication.

Resource URL

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

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

Expand
titleSample request URL for delete

<ConfluenceBaseURL>/rest/polls/1.0/poll/f2945cb488a341198bb7ecf173f5db07

Example response

Expand
titleSample response after successful execution of request

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

Error codes

Code

Cause of error

Message displayed

404

Poll with given poll guid is 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’.

...