Skip to main content
Surveys is a standalone Contact Button product with its own dashboard, side-menu destination, public experience, and API v1 resources. The dashboard and API both read and write the same survey definition, including stable question IDs, brand design, respondent fields, conditional routing, publishing state, and distribution settings.

Question types

  • nps accepts a score from 0 through 10.
  • rating accepts a configured scale from 2 through 10.
  • choice accepts one configured option.
  • multiple_choice accepts one or more configured options.
  • text accepts an open response.
Each question has a stable ID. Persist those IDs in integrations instead of relying on question order or copy. A question can optionally route forward to another question when an answer matches its branching rule.

Publish and collect

Create or update a survey under /v1/workspaces/{workspace}/surveys. Setting status to published activates its browser URL and the unauthenticated /v1/public/surveys/{survey} representation. Public responses are rate limited and accept an Idempotency-Key, so a client can safely retry after a network failure. The response endpoint validates every answer against the live survey definition. Respondent identity is optional and a matching existing workspace contact is linked without copying data across tenant boundaries.

SMS and WhatsApp preflight

Use /distribution-preview before handing a message to a channel adapter. The preflight validates the E.164 recipient, consent source and capture time, locale, SMS sender readiness, and WhatsApp Business template requirements. It returns the final attributed survey URL and message but does not send anything.
Never infer consent from the presence of a phone number. Store the channel-specific consent source and capture time with every delivery request, and continue to enforce opt-out and quiet-hour rules in the provider adapter.
Survey links include channel=sms, channel=whatsapp, channel=email, channel=embed, or another allowed source. The response stores that channel for attribution and results reporting.