The Zigpoll connector lets your AI agent act in each user's Zigpoll account. Each user connects their own Zigpoll access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 27 tools.
- Tools
- 27
- What they doRead · write · destructive
- 19 · 8 · 019 read8 write0 destructive
- Users sign in with
- Access token
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Zigpoll connection
In AgentKit > Connections, create a Zigpoll connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'zigpoll'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Zigpoll:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'zigpoll_get_current_user',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "zigpoll"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Zigpoll:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="zigpoll_get_current_user",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Zigpoll credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolzigpoll_get_accountGet one Zigpoll account by id.Read-onlyGet Account
Get one Zigpoll account by id. Returns the account's title, plan, owner and admin, poll ids, isShopify flag and usage counters. Use zigpoll_list_accounts to find the id first.
Inputs
accountIdstringrequired- ID of the Zigpoll account (the account `_id`, e.g. from zigpoll_list_accounts).
zigpoll_get_current_userGet the user that owns the API key.Read-onlyGet Current User
Get the user that owns the API key. Returns the user id, name, email and the list of account ids the key can reach. Use it to confirm the connection works; use zigpoll_list_accounts for account details.
Inputs
This tool takes no inputs.
zigpoll_get_pollGet one poll (survey) by id.Read-onlyGet Poll
Get one poll (survey) by id. Returns the poll's title, status, visibility, page rules, slide ids, settings and engagement counters. Use zigpoll_list_polls to find the id; use zigpoll_list_slides for the question content.
Inputs
pollIdstringrequired- ID of the poll (survey), the `_id` returned by zigpoll_list_polls.
zigpoll_get_poll_action_logicGet a survey's Action Logic rules and the actions available for writing new ones.Read-onlyGet Poll Action Logic
Get a survey's Action Logic rules and the actions available for writing new ones. Returns the current rules plus the actions this account can use now and those available once an integration is connected. Use it to inspect rules that run after a response.
Inputs
pollIdstringrequired- ID of the poll (survey), the `_id` returned by zigpoll_list_polls.
zigpoll_get_poll_attributionGet the attributed revenue report for one 'How did you hear about us?' question.Read-onlyGet Poll Attribution
Get the attributed revenue report for one 'How did you hear about us?' question. Returns per-answer orders, revenue, average order value and share, a byPeriod series and a comparison with the previous window. Use it to see which marketing channels drive orders; use zigpoll_get_poll_metadata for non-revenue metadata breakdowns.
Inputs
accountIdstring- ID of the Zigpoll account (the account `_id`, e.g. from zigpoll_list_accounts). Provide the account that owns the survey.
createdAfterstring- Only return records created on or after this time, as a JavaScript timestamp in milliseconds (for example 1760000000000). Use it for incremental sync.
createdBeforestring- Only return records created on or before this time, as a JavaScript timestamp in milliseconds (for example 1760000000000).
granularitystring- Period size for the byPeriod series: day, week (default) or month; weeks start on Monday.one of
dayweekmonth groupBystring- Response-metadata field to cross-tab answers against (default `source`), for example utm_source, utm_medium, utm_campaign or landing-page.one of
attribution_channelattribution_sourcesourceutm_sourceutm_mediumutm_campaignoriginal-referrerlanding-pagesourceTypeutm_contentutm_termcampaign_nameadset_namead_nameplacementsite_source_namegad_sourceutm_source_platformutm_creative_formatutm_marketing_tacticlandingPagereferrerUrlshopify_order_discount_codes slideIdstring- ID of the slide (question), the `_id` returned by zigpoll_list_slides. The attribution question to report on.
timezoneOffsetstring- Minutes offset from UTC used for day bucketing (for example -300 for UTC-5).
zigpoll_get_poll_devicesGet the device type, browser and operating system breakdown of respondents.Read-onlyGet Poll Devices
Get the device type, browser and operating system breakdown of respondents. Returns totalParticipants and distributions for deviceTypes, browsers and operatingSystems, with a truncated flag. Use zigpoll_get_poll_locations for geography.
Inputs
accountIdstring- ID of the Zigpoll account (the account `_id`, e.g. from zigpoll_list_accounts). Provide one of accountId, pollId or slideId.
pollIdstring- ID of the poll (survey), the `_id` returned by zigpoll_list_polls. Provide one of accountId, pollId or slideId.
slideIdstring- ID of the slide (question), the `_id` returned by zigpoll_list_slides. Provide one of accountId, pollId or slideId.
zigpoll_get_poll_locationsGet the geographic breakdown of respondents.Read-onlyGet Poll Locations
Get the geographic breakdown of respondents. Returns totalParticipants and the top 25 countries, regions and cities, with a truncated flag. Use zigpoll_get_poll_devices for device and browser data.
Inputs
accountIdstring- ID of the Zigpoll account (the account `_id`, e.g. from zigpoll_list_accounts). Provide one of accountId, pollId or slideId.
pollIdstring- ID of the poll (survey), the `_id` returned by zigpoll_list_polls. Provide one of accountId, pollId or slideId.
slideIdstring- ID of the slide (question), the `_id` returned by zigpoll_list_slides. Provide one of accountId, pollId or slideId.
zigpoll_get_poll_metadataGet an aggregated breakdown of response metadata such as utm_source, referrer, landing page or custom keys.Read-onlyGet Poll Metadata
Get an aggregated breakdown of response metadata such as utm_source, referrer, landing page or custom keys. Returns the available metadata keys when key is omitted, or the value distribution for one key. Call it without key first to discover keys; use zigpoll_get_poll_attribution for revenue by channel.
Inputs
accountIdstring- ID of the Zigpoll account (the account `_id`, e.g. from zigpoll_list_accounts). Provide one of accountId, pollId or slideId.
createdAfterstring- Only return records created on or after this time, as a JavaScript timestamp in milliseconds (for example 1760000000000). Use it for incremental sync.
createdBeforestring- Only return records created on or before this time, as a JavaScript timestamp in milliseconds (for example 1760000000000).
keystring- Metadata key to break down, for example utm_source. Omit to list the available keys.
pollIdstring- ID of the poll (survey), the `_id` returned by zigpoll_list_polls. Provide one of accountId, pollId or slideId.
slideIdstring- ID of the slide (question), the `_id` returned by zigpoll_list_slides. Provide one of accountId, pollId or slideId.
zigpoll_get_poll_patternsGet the statistically tested patterns Zigpoll has precomputed for a survey.Read-onlyGet Poll Patterns
Get the statistically tested patterns Zigpoll has precomputed for a survey. Returns patterns strongest first (links between answers and who respondents are, where they came from or what they bought), plus the run record per survey. Use zigpoll_list_insights for AI-written summaries.
Inputs
accountIdstring- ID of the Zigpoll account (the account `_id`, e.g. from zigpoll_list_accounts). Provide one of accountId, pollId or slideId.
limitinteger- Number of patterns to return. Default 50, maximum 200.
pollIdstring- ID of the poll (survey), the `_id` returned by zigpoll_list_polls. Provide one of accountId, pollId or slideId.
slideIdstring- ID of the slide (question), the `_id` returned by zigpoll_list_slides. Provide one of accountId, pollId or slideId.
zigpoll_get_poll_translationsGet the translation state of a poll.Read-onlyGet Poll Translations
Get the translation state of a poll. Returns the languages it is translated into with coverage counts, the translatable CTA keys and the source content; with language set it also returns that language's current translations. Use it to inspect translations before editing a survey.
Inputs
pollIdstringrequired- ID of the poll (survey), the `_id` returned by zigpoll_list_polls.
languagestring- ISO 639 language code, optionally region-qualified (for example de or pt-BR), or `default`. When set, the response includes that language's current translations.
zigpoll_get_poll_trendsGet response volume over time, bucketed by day.Read-onlyGet Poll Trends
Get response volume over time, bucketed by day. Returns the unit and a trends series; with slideId the buckets are per answer option, with only pollId the unit is whole survey responses. Use it to chart response volume; use zigpoll_get_poll_attribution for revenue by answer.
Inputs
accountIdstring- ID of the Zigpoll account (the account `_id`, e.g. from zigpoll_list_accounts). Provide one of accountId, pollId or slideId.
createdAfterstring- Only return records created on or after this time, as a JavaScript timestamp in milliseconds (for example 1760000000000). Use it for incremental sync.
createdBeforestring- Only return records created on or before this time, as a JavaScript timestamp in milliseconds (for example 1760000000000).
pollIdstring- ID of the poll (survey), the `_id` returned by zigpoll_list_polls. Provide one of accountId, pollId or slideId.
slideIdstring- ID of the slide (question), the `_id` returned by zigpoll_list_slides. Provide one of accountId, pollId or slideId.
timezoneOffsetstring- Minutes offset from UTC used for day bucketing; only applies when slideId is given (for example -300 for UTC-5).
zigpoll_get_slideGet one slide (question) by id.Read-onlyGet Slide
Get one slide (question) by id. Returns the slide's title, type, answer options with vote counts, copy and view counters. Use zigpoll_list_slides to find the id.
Inputs
slideIdstringrequired- ID of the slide (question), the `_id` returned by zigpoll_list_slides.
zigpoll_list_accountsList every Zigpoll account the API key can reach.Read-onlyList Accounts
List every Zigpoll account the API key can reach. Returns each account's id, title, plan, Shopify flag, poll ids and response, participant and email counters. Use it first to find an accountId; use zigpoll_get_account for one account.
Inputs
This tool takes no inputs.
zigpoll_list_emailsList the email addresses collected by surveys in an account, poll or slide.Read-onlyList Emails
List the email addresses collected by surveys in an account, poll or slide. Returns a cursor-paginated page with data, hasNextPage and endCursor; each record is a collected email object. Use zigpoll_list_participants for respondent profiles without email capture.
Inputs
accountIdstring- ID of the Zigpoll account (the account `_id`, e.g. from zigpoll_list_accounts). Provide exactly one of accountId, pollId or slideId to choose the scope.
createdAfterstring- Only return records created on or after this time, as a JavaScript timestamp in milliseconds (for example 1760000000000). Use it for incremental sync.
createdBeforestring- Only return records created on or before this time, as a JavaScript timestamp in milliseconds (for example 1760000000000).
limitinteger- Page size. Default 50, maximum 5000. Use a large limit for bulk exports.
pollIdstring- ID of the poll (survey), the `_id` returned by zigpoll_list_polls. Provide exactly one of accountId, pollId or slideId to choose the scope.
slideIdstring- ID of the slide (question), the `_id` returned by zigpoll_list_slides. Provide exactly one of accountId, pollId or slideId to choose the scope.
startCursorstring- Pagination cursor. Pass the `_id` of the last record from the previous page (also returned as `endCursor`) to fetch the next page; stop when `hasNextPage` is false.
zigpoll_list_insightsList the automated AI insights Zigpoll generated for an account, poll or slide.Read-onlyList Insights
List the automated AI insights Zigpoll generated for an account, poll or slide. Returns a cursor-paginated page with data, hasNextPage and endCursor; each insight is an AI-generated summary of the responses. Use zigpoll_get_poll_patterns for statistically tested findings.
Inputs
accountIdstring- ID of the Zigpoll account (the account `_id`, e.g. from zigpoll_list_accounts). Provide exactly one of accountId, pollId or slideId to choose the scope.
limitinteger- Page size. Default 50, maximum 5000. Use a large limit for bulk exports.
pollIdstring- ID of the poll (survey), the `_id` returned by zigpoll_list_polls. Provide exactly one of accountId, pollId or slideId to choose the scope.
slideIdstring- ID of the slide (question), the `_id` returned by zigpoll_list_slides. Provide exactly one of accountId, pollId or slideId to choose the scope.
startCursorstring- Pagination cursor. Pass the `_id` of the last record from the previous page (also returned as `endCursor`) to fetch the next page; stop when `hasNextPage` is false.
zigpoll_list_participantsList the participants who took surveys in an account, poll or slide.Read-onlyList Participants
List the participants who took surveys in an account, poll or slide. Returns a cursor-paginated page with data, hasNextPage and endCursor; each participant has an id, metadata and response history fields. Use zigpoll_list_responses for the answers themselves.
Inputs
accountIdstring- ID of the Zigpoll account (the account `_id`, e.g. from zigpoll_list_accounts). Provide exactly one of accountId, pollId or slideId to choose the scope.
createdAfterstring- Only return records created on or after this time, as a JavaScript timestamp in milliseconds (for example 1760000000000). Use it for incremental sync.
createdBeforestring- Only return records created on or before this time, as a JavaScript timestamp in milliseconds (for example 1760000000000).
limitinteger- Page size. Default 50, maximum 5000. Use a large limit for bulk exports.
pollIdstring- ID of the poll (survey), the `_id` returned by zigpoll_list_polls. Provide exactly one of accountId, pollId or slideId to choose the scope.
slideIdstring- ID of the slide (question), the `_id` returned by zigpoll_list_slides. Provide exactly one of accountId, pollId or slideId to choose the scope.
startCursorstring- Pagination cursor. Pass the `_id` of the last record from the previous page (also returned as `endCursor`) to fetch the next page; stop when `hasNextPage` is false.
zigpoll_list_pollsList the polls (surveys) in an account.Read-onlyList Polls
List the polls (surveys) in an account. Returns each poll's id, title, status, visibility, archive flag, page rules, slide ids and engagement counters. Use zigpoll_get_poll for one poll; use zigpoll_list_slides for its questions.
Inputs
accountIdstringrequired- ID of the Zigpoll account (the account `_id`, e.g. from zigpoll_list_accounts).
zigpoll_list_responsesList participant responses for an account, poll or slide, newest first by default.Read-onlyList Responses
List participant responses for an account, poll or slide, newest first by default. Returns a cursor-paginated page with data, hasNextPage and endCursor; each response has the compiled answer text and, for multi-answer questions, an answers list of the picked options. Use zigpoll_list_participants for respondent profiles; do not build frequency counts from the response text of multi-answer questions.
Inputs
accountIdstring- ID of the Zigpoll account (the account `_id`, e.g. from zigpoll_list_accounts). Provide exactly one of accountId, pollId or slideId to choose the scope.
createdAfterstring- Only return records created on or after this time, as a JavaScript timestamp in milliseconds (for example 1760000000000). Use it for incremental sync.
createdBeforestring- Only return records created on or before this time, as a JavaScript timestamp in milliseconds (for example 1760000000000).
filterstring- Return only one kind of answer: `fixed-choice` keeps answers picked from predefined options, `open-ended` keeps free-text write-ins. Omit to return everything.one of
fixed-choiceopen-ended limitinteger- Page size. Default 50, maximum 5000. Use a large limit for bulk exports.
orderstring- Page order: `newest` (default) returns the latest responses first, `oldest` walks forward from the earliest response. Pass the last _id as startCursor to continue in the same order.one of
newestoldest pollIdstring- ID of the poll (survey), the `_id` returned by zigpoll_list_polls. Provide exactly one of accountId, pollId or slideId to choose the scope.
slideIdstring- ID of the slide (question), the `_id` returned by zigpoll_list_slides. Provide exactly one of accountId, pollId or slideId to choose the scope.
startCursorstring- Pagination cursor. Pass the `_id` of the last record from the previous page (also returned as `endCursor`) to fetch the next page; stop when `hasNextPage` is false.
zigpoll_list_slidesList the slides (questions) of a poll.Read-onlyList Slides
List the slides (questions) of a poll. Returns each slide's id, title, handle, type, answer options with vote counts and view counters. Use zigpoll_get_slide for one slide; pass createdAfter or createdBefore to count votes in a time window.
Inputs
pollIdstringrequired- ID of the poll (survey), the `_id` returned by zigpoll_list_polls.
createdAfterstring- Only return records created on or after this time, as a JavaScript timestamp in milliseconds (for example 1760000000000). Use it for incremental sync.
createdBeforestring- Only return records created on or before this time, as a JavaScript timestamp in milliseconds (for example 1760000000000).
zigpoll_create_pollCreate a new poll (survey) under an account you own.WriteCreate Poll
Create a new poll (survey) under an account you own. Returns the created poll with its id; it starts hidden (isVisible false) and with no slides. Follow with zigpoll_create_slide to add questions, then zigpoll_update_poll with isVisible true to publish.
Inputs
accountIdstringrequired- ID of the Zigpoll account (the account `_id`, e.g. from zigpoll_list_accounts).
titlestringrequired- Title of the new poll, for example 'Post-Purchase Feedback'.
displaySettingsobject- Visual display settings object (colors, fonts, position, shape), for example {"backgroundColor": "#212a2f", "align": "right"}.
emailDisplaySettingsobject- Email delivery display settings object (subject, colors, content), for example {"subject": "Have a minute for a quick survey?"}.
pageDisplaySettingsobject- Standalone page display settings object (colors, fonts, layout).
pageExcludeRulesarray- URL path rules for where the poll must not appear, as a list of strings.
pageRulesarray- URL path rules for where the poll appears, as a list of strings, for example ["/thank-you"]. Shopify surfaces use fixed paths such as /(.*)/thank_you (Thank You page), /:order_number/orders/:variable (Order Status) and /account (customer accounts).
scheduleobject- Activation and deactivation schedule, either immediate or scheduled with ISO dates, as a JSON object.
settingsobject- Poll settings object, for example {"showCounter": true, "allowResubmissions": false, "notifyOnComplete": true}. On update it replaces the entire settings object, so send the full object.
smsDisplaySettingsobject- SMS delivery settings object, for example {"message": "We want your feedback! Click the link to complete our survey."}.
targetingSettingsobject- Audience targeting by percentage, geography, browser, device type, referral, IP or metadata, as a JSON object.
visibilitySettingsobject- Auto-open, exit-intent and hide-after rules, for example {"autoOpenDevice": false, "hideAfterSubmission": false}. On update these are merged with existing values, so partial objects are fine.
zigpoll_create_slideAdd a new slide (question) to an existing poll.WriteCreate Slide
Add a new slide (question) to an existing poll. Returns the created slide with its id, handle, type and answer options. Use zigpoll_list_slides to see existing questions; use zigpoll_update_slide to change one; pass idx to insert at a position.
Inputs
pollIdstringrequired- ID of the poll (survey), the `_id` returned by zigpoll_list_polls. The poll must belong to an account you own.
typestringrequired- Slide type: question, checkbox, dropdown, autocomplete, image-choice, binary, legal-consent, inline-multiple-choice, star-rating, range, satisfaction, slider, short-answer, long-answer, email-capture, phone-capture, date, file-upload, country, rank, form, copy, thank-you, reward, action or matrix.one of
questioncheckboxdropdownautocompleteimage-choicebinarylegal-consentinline-multiple-choicestar-ratingrangesatisfactionslidershort-answerlong-answeremail-capturephone-capturedatefile-uploadcountryrankformcopythank-yourewardactionmatrix actionsarray- Action buttons for action slides, as a list of objects with title, color, icon and link, for example [{"title": "Shop now", "link": "https://example.com"}].
answersarray- Answer options for choice-based slide types, as a list of objects with a title, for example [{"title": "Instagram"}, {"title": "A friend"}]. For matrix slides these are the shared columns; for legal-consent pass one answer whose title is the checkbox label.
copystring- Body copy for the slide; HTML is supported.
displayLogicarray- Display logic rules controlling when this slide is shown, as a list of rule objects.
formInputsarray- Form fields for form slides, as a list of objects with label, type (short-answer, long-answer, email-capture, radio, checkbox, select, inline-multiple-choice or file-upload), optional and options, for example [{"label": "Email", "type": "email-capture", "optional": false}].
idxinteger- Position to insert the slide in the poll's slide list (0 is first). Appended to the end when omitted.
leftLabelstring- Left label for range, satisfaction and star-rating slides.
logicarray- Conditional logic rules for branching and actions, as a list of rule objects.
multiboolean- Allow multiple selections (checkbox and inline-multiple-choice slides).
nextSlidestring- ID of the slide to show next, or "-1" to end the survey.
placeholderstring- Placeholder text for free-text inputs.
rewardBannerstring- Banner text shown above the reward code.
rewardCodestring- Discount or reward code shown on reward slides.
rewardCodeTypestring- How the reward code is produced: static, dynamic or free-shipping.one of
staticdynamicfree-shipping rightLabelstring- Right label for range, satisfaction and star-rating slides.
rowsarray- Question rows for matrix slides, as a list of objects with a title, for example [{"title": "Quality"}, {"title": "Price"}]. Each row is answered from the shared answers (columns).
settingsobject- Slide settings object, for example {"showTitle": true, "optional": false, "hidden": false}.
subtitlestring- Slide subtitle shown under the title.
titlestring- Slide title (the question text).
zigpoll_generate_survey_linkGenerate a unique, trackable survey link for one respondent.WriteGenerate Survey Link
Generate a unique, trackable survey link for one respondent. Returns the url and the activityId of the new activity record. Use it to hand out per-person links with metadata; use zigpoll_send_email or zigpoll_send_sms to deliver invitations directly.
Inputs
pollIdstringrequired- ID of the poll (survey), the `_id` returned by zigpoll_list_polls.
expiresAtstring- ISO 8601 datetime after which the link expires, for example 2026-12-31T23:59:59Z.
metadataobject- Key-value metadata to attach to the activity record, for example {"orderId": "1001", "campaign": "spring"}.
zigpoll_reorder_slidesSet the order in which a poll's slides appear.WriteReorder Slides
Set the order in which a poll's slides appear. Returns the survey's slide order after the write. slideIds must list every slide on the poll exactly once; get them from zigpoll_list_slides first.
Inputs
pollIdstringrequired- ID of the poll (survey), the `_id` returned by zigpoll_list_polls.
slideIdsarrayrequired- Every slide id on the poll, in the order they should appear. The list must be complete with no duplicates.
zigpoll_send_emailSend an email survey invitation to one or more recipients.WriteSend Email Campaign
Send an email survey invitation to one or more recipients. Returns success with the number sent and skipped; malformed, placeholder and duplicate addresses are skipped. This emails real people; use zigpoll_generate_survey_link if you only need a link.
Inputs
pollIdstringrequired- ID of the poll (survey), the `_id` returned by zigpoll_list_polls.
recipientsarrayrequired- Email addresses to invite, as a list of strings. Addresses are lowercased and de-duplicated.
emailDisplaySettingsobject- Optional email display settings override (sender, content, colors) for this send, as a JSON object.
zigpoll_send_smsSend an SMS survey invitation to one or more phone numbers.WriteSend SMS Campaign
Send an SMS survey invitation to one or more phone numbers. Returns success once the campaign is queued; numbers are normalized and de-duplicated. This texts real people; use zigpoll_generate_survey_link if you only need a link.
Inputs
pollIdstringrequired- ID of the poll (survey), the `_id` returned by zigpoll_list_polls.
recipientsarrayrequired- Phone numbers to invite, as a list of strings in E.164 (+14155550123) or domestic format.
messagestring- SMS message override. Defaults to the poll or account SMS settings.
zigpoll_update_pollUpdate an existing poll (survey); only the fields you send are changed.WriteUpdate Poll
Update an existing poll (survey); only the fields you send are changed. Returns the updated poll object. Use it to rename, publish (isVisible true needs at least one slide), archive or change settings; use zigpoll_update_slide to edit questions.
Inputs
pollIdstringrequired- ID of the poll (survey), the `_id` returned by zigpoll_list_polls.
displaySettingsobject- Visual display settings object (colors, fonts, position, shape), for example {"backgroundColor": "#212a2f", "align": "right"}.
emailDisplaySettingsobject- Email delivery display settings object (subject, colors, content), for example {"subject": "Have a minute for a quick survey?"}.
isArchivedboolean- Whether the poll is archived.
isVisibleboolean- Whether the poll is live. Cannot be set to true if the poll has no slides or is archived.
pageDisplaySettingsobject- Standalone page display settings object (colors, fonts, layout).
pageExcludeRulesarray- URL path rules for where the poll must not appear, as a list of strings.
pageRulesarray- URL path rules for where the poll appears, as a list of strings, for example ["/thank-you"]. Shopify surfaces use fixed paths such as /(.*)/thank_you (Thank You page), /:order_number/orders/:variable (Order Status) and /account (customer accounts).
scheduleobject- Activation and deactivation schedule, either immediate or scheduled with ISO dates, as a JSON object.
settingsobject- Poll settings object, for example {"showCounter": true, "allowResubmissions": false, "notifyOnComplete": true}. On update it replaces the entire settings object, so send the full object.
smsDisplaySettingsobject- SMS delivery settings object, for example {"message": "We want your feedback! Click the link to complete our survey."}.
targetingSettingsobject- Audience targeting by percentage, geography, browser, device type, referral, IP or metadata, as a JSON object.
titlestring- New title of the poll.
visibilitySettingsobject- Auto-open, exit-intent and hide-after rules, for example {"autoOpenDevice": false, "hideAfterSubmission": false}. On update these are merged with existing values, so partial objects are fine.
zigpoll_update_slideUpdate an existing slide (question); only the fields you send are changed.WriteUpdate Slide
Update an existing slide (question); only the fields you send are changed. Returns the updated slide object. Use it to edit question text, answers or settings; settings replaces the whole settings object; use zigpoll_create_slide to add a new question.
Inputs
slideIdstringrequired- ID of the slide (question), the `_id` returned by zigpoll_list_slides.
actionsarray- Action buttons for action slides, as a list of objects with title, color, icon and link, for example [{"title": "Shop now", "link": "https://example.com"}].
answersarray- Answer options for choice-based slide types, as a list of objects with a title, for example [{"title": "Instagram"}, {"title": "A friend"}]. For matrix slides these are the shared columns; for legal-consent pass one answer whose title is the checkbox label.
copystring- Body copy for the slide; HTML is supported.
displayLogicarray- Display logic rules controlling when this slide is shown, as a list of rule objects.
formInputsarray- Form fields for form slides, as a list of objects with label, type (short-answer, long-answer, email-capture, radio, checkbox, select, inline-multiple-choice or file-upload), optional and options, for example [{"label": "Email", "type": "email-capture", "optional": false}].
leftLabelstring- Left label for range, satisfaction and star-rating slides.
logicarray- Conditional logic rules for branching and actions, as a list of rule objects.
multiboolean- Allow multiple selections (checkbox and inline-multiple-choice slides).
nextSlidestring- ID of the slide to show next, or "-1" to end the survey.
placeholderstring- Placeholder text for free-text inputs.
pollIdstring- ID of the poll the slide belongs to. Defaults to the slide's current poll.
rewardBannerstring- Banner text shown above the reward code.
rewardCodestring- Discount or reward code shown on reward slides.
rewardCodeTypestring- How the reward code is produced: static, dynamic or free-shipping.one of
staticdynamicfree-shipping rightLabelstring- Right label for range, satisfaction and star-rating slides.
rowsarray- Question rows for matrix slides, as a list of objects with a title, for example [{"title": "Quality"}, {"title": "Price"}]. Each row is answered from the shared answers (columns).
settingsobject- Slide settings object, for example {"showTitle": true, "optional": false, "hidden": false}. On update it replaces the entire settings object, so send the current settings with your change; hidden true skips the question without deleting it.
subtitlestring- Slide subtitle shown under the title.
titlestring- Slide title (the question text).
typestring- Change the slide type to one of the valid slide types.one of
questioncheckboxdropdownautocompleteimage-choicebinarylegal-consentinline-multiple-choicestar-ratingrangesatisfactionslidershort-answerlong-answeremail-capturephone-capturedatefile-uploadcountryrankformcopythank-yourewardactionmatrix
No tools match.
