Close a poll now (logged)

POST

/api/v1/workspaces/{workspace}/polls/{pollId}/close

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "https://reputecast.example.com/api/v1/workspaces/acme-newsletter/polls/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/close"

  req, _ := http.NewRequest("POST", url, nil)

  req.Header.Add("Authorization", "Bearer <token>")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

const url = 'https://reputecast.example.com/api/v1/workspaces/acme-newsletter/polls/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/close';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/polls/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/close \
  --header 'Authorization: Bearer <token>'

Permission: campaigns:edit

Its answer page says when it closed and records nothing.

Authorizations

bearer

Parameters

Path Parameters

workspace

required

Workspace slug

string

/^[a-z0-9][a-z0-9-]{1,62}$/

Workspace slug

pollId

required

Poll id

string format: uuid

Poll id

Responses

200

application/json

object

answerPage

required

string

answers

required

integer format: int64

automated

required

object

gateways

required

integer format: int64

prefetch

required

integer format: int64

total

required

integer format: int64

blockId

required

string

breakdown

required

object

languages

required

Array<object>

object

answers

required

integer format: int64

counts

required

Array<object>

object

count

required

integer format: int64

emoji

string

key

required

integer format: int64

label

required

string

percent

required

number format: double

tag

string

key

required

string

label

required

string

nps

integer format: int64

percent

required

number format: double

tooFew

required

boolean

lists

required

Array<object>

object

answers

required

integer format: int64

counts

required

Array<object>

object

count

required

integer format: int64

emoji

string

key

required

integer format: int64

label

required

string

percent

required

number format: double

tag

string

key

required

string

label

required

string

nps

integer format: int64

percent

required

number format: double

tooFew

required

boolean

tiers

required

Array<object>

object

answers

required

integer format: int64

counts

required

Array<object>

object

count

required

integer format: int64

emoji

string

key

required

integer format: int64

label

required

string

percent

required

number format: double

tag

string

key

required

string

label

required

string

nps

integer format: int64

percent

required

number format: double

tooFew

required

boolean

campaign

required

string

campaignId

string

canClose

required

boolean

canExportAnswers

required

boolean

changed

required

integer format: int64

closeHelpers

required

Array<string>

closedAsScheduled

required

boolean

closedAt

string format: date-time

closedBy

string

closesAt

string format: date-time

comments

required

integer format: int64

config

required

string

counts

required

Array<object>

object

count

required

integer format: int64

emoji

string

key

required

integer format: int64

label

required

string

percent

required

number format: double

tag

string

delivered

required

integer format: int64

exportHelpers

required

Array<string>

field

string

high

string

required

string

kind

required

string

Allowed values: choice scale emoji

live

required

boolean

low

string

names

required

boolean

nonContacts

required

integer format: int64

nps

object

detractorPercent

required

number format: double

detractors

required

integer format: int64

passivePercent

required

number format: double

passives

required

integer format: int64

promoterPercent

required

number format: double

promoters

required

integer format: int64

score

required

integer format: int64

npsWording

required

boolean

overTime

required

object

after

required

integer format: int64

cumulative

required

Array<integer>

firstSixPercent

required

number format: double

since

string format: date-time

percent

required

number format: double

question

required

string

reopenedAt

string format: date-time

save

required

string

Allowed values: none tag field

startedAt

string format: date-time

status

required

string

Allowed values: open closed

tests

required

integer format: int64

Example

{
  "kind": "choice",
  "save": "none",
  "status": "open"
}

default

Error

application/problem+json

object

code

Stable error code, e.g. permission_denied

string

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object>

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

helpers

Members who hold the missing permission

Array<string>

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

meta

object

key

additional properties

permission

The missing permission key

string

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

Example

{
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}