Surveys

Create survey

Creates a new survey in draft status. The survey must be published separately using the publish endpoint.

Each survey contains one or more questions, each with a type (head_to_head, ranked, open_ended, etc.) and optional answer options. You can also specify targeting traits, reporting breakdowns, country, and sample size.

To start from a template instead, send template (an id from GET /v1/templates, plus any blanks and options) in place of questions. The draft is checked against the template limits before anything is written; a request outside them is a 422 listing every violation with its allowed values.

post/surveys

Request

  • Base URL: https://api.pickfu.com/v1
  • URL: https://api.pickfu.com/v1/surveys
  • Auth: HTTP bearer

Request body

namestring

Survey name (1-255 characters, trimmed)

targetingstring[]

Demographic targeting traits

reportingstring[]

Reporting breakdown traits

countrystring

Two-letter country code (e.g. US)

sampleSizestring

Number of respondents. Standard surveys: "15", "30", "50", "75", "100", "200", "300", "500". Screen recording surveys: "5", "10", "15", "20", "25", "30", "50", "75" (max 75).

surveyIntentstring

Original intent of the survey as interpreted by AI (max 255 characters)

isMiniPollboolean

Whether to create this survey as a daily mini-poll

externalIdstring

Optional opaque correlation key for your own records. Omit when unset. Case-sensitive and byte-exact — send the identical string every time. Many surveys may share the same id. We do not interpret this value.

Response

Default Response

successboolean

Changes

No recorded changes to this operation across all 1 revision of this API.