Create poll

post

https://v1.zigpoll.com/poll

Create a new poll (survey) under an account you own. The poll is created with isVisible: false and no slides. You can also use /survey as an alias.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

accountId

string

required

The ID of the account to create the poll under. You must own this account.

title

string

required

The title of the poll.

dryRun

boolean

If true, the poll object is built with all defaults and sanitization applied but is NOT saved to the database. Returns { data } containing the full preview. Use POST /commit with the returned data to save it.

isSynthetic

boolean

Defaults to false

Mark this poll as a synthetic research poll. When true, sets settings.isSynthetic on the stored poll (the canonical location). Required before calling /research/start. This field is immutable — it cannot be changed after the poll is created.

pageRules

array of strings

Defaults to

URL path rules for where the poll should appear. Defaults to an empty array.

pageRules

pageExcludeRules

array of strings

URL path rules for where the poll should NOT appear.

pageExcludeRules

settings

object

Poll settings. If omitted, defaults are applied (showCounter: true, allowResubmissions: false, notifyOnComplete: true, urlDependant: false, automaticallySwitchSlides: true, autoClose: false, allowEdits: false, apiOnly: false).

displaySettings

object

Visual display settings (colors, fonts, positioning, shape, etc.). If omitted, defaults are applied and merged with account-level settings (backgroundColor: '#212a2f', actionColor: '#212a2f', notificationColor: '#F26c57', showLink: false, align: 'right', borderRadius: 8, borderWidth: 1, maxWidth: 400, maxHeight: 575, position: [20, 20], shape: 'bumper', hideLauncher: true, showCounter: true).

emailDisplaySettings

object

Email delivery display settings (subject, colors, content blocks). If omitted, defaults are applied and merged with account-level settings (subject: 'Have a minute for a quick survey?', backgroundColor: '#f5f7f9', foregroundColor: '#ffffff', buttonColor: '#212a2f', buttonFontColor: '#ffffff', fontColor: '#000000', fontFamily: 'sans', showLink: false, linkType: 'input').

smsDisplaySettings

object

SMS delivery settings (message text). If omitted, defaults are applied and merged with account-level settings (message: 'We want your feedback! Click the link to complete our survey.').

pageDisplaySettings

object

Standalone page display settings (colors, fonts, layout).

visibilitySettings

object

Controls for auto-open behavior, exit intent, and hide-after rules. If omitted, defaults are applied and merged with account-level settings (autoOpenDevice: false, autoOpenDuration: 0, autoOpenPosition: 0, autoOpenDurationType: 'page', renderOnExitIntent: false, renderDuration: false, renderPosition: false, renderDevice: false, renderDurationType: 'page', hideAfterSubmission: false, hideAfterClose: true, showAfterSubmission: false, openAttempts: true).

targetingSettings

object

Audience targeting by percentage, geography, technology, referral, IP, or metadata.

schedule

object

Activation and deactivation schedule (immediate or scheduled with ISO dates).

languageSettings

object

Language/translation settings.

Responses

404

Account not found or you do not own it

200The created poll object

422Missing required field (accountId or title)