Skip to main content
POST
/
surveys
/
{id}
/
respondents
Add respondents
curl --request POST \
  --url https://api.pickfu.com/v1/surveys/{id}/respondents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "respondentsAmount": 500,
  "preview": false
}
'
{
  "success": true,
  "preview": true,
  "data": {
    "currentRespondents": 123,
    "newRespondents": 123,
    "additionalRespondents": 123,
    "costInCredits": 123,
    "creditBalance": 123,
    "canPayWithCredits": true,
    "id": "<string>",
    "respondentsAmount": 123,
    "state": "<string>"
  }
}

Authorizations

Authorization
string
header
required

OAuth2 access token obtained via the authorization flow. Include in the Authorization header as: Bearer {access_token}

Path Parameters

id
string
required

Survey ID (GUID)

Body

application/json
respondentsAmount
integer
required

The new total number of respondents (not the delta). Must be greater than the current amount.

Required range: 1 <= x <= 1000
preview
boolean
default:false

If true, returns cost estimate without making changes.

Response

Default Response

success
boolean
preview
boolean
data
object