SurveyCampaignClient

The eligible campaign to show, or null if none

  • cta
    Type: object | null · SurveyCta
    required

    Completion CTA shown after the last question, or null for today's toast-and-close

    • href
      Type: string
      required

      Absolute outbound URL

    • kind
      Type: string · SurveyCtaKindenum
      required
      values
      • review
      • link
    • label
      Type: string
      required

      Button text

  • description
    Type: string | null
    required
  • id
    Type: string
    required

    Campaign uuid (echo back on respond)

  • key
    Type: string
    required

    Stable slug, e.g. 'pmf-2026-q3'

  • questions
    Type: array object[] · SurveyQuestion[]
    required
    • id
      Type: string
      required

      Stable within the campaign

    • label
      Type: string
      required
    • type
      Type: string · SurveyQuestionTypeenum
      required
      values
      • single
      • multi
      • text
      • scale
      • nps
    • options
      Type: array object[] · SurveyQuestionOption[]

      Choices for single | multi

    • required
      Type: boolean
    • scale
      Type: object · SurveyQuestionScale

      Bounds for scale | nps

  • title
    Type: string
    required