Skip to main content

StartSurveyResponse opens a new in-progress response for a participant.

POST 
/api/v1/surveys/responses/start

Call this when the participant has accepted (explicitly or implicitly) to take the survey, before collecting any answers. The returned response_id is used in all subsequent answer-submission calls.

Use this when you want to build up answers incrementally via SubmitPartialResponse. For one-shot submissions (all answers at once), skip straight to SubmitSurveyResponse.

Parameters​

  • survey_version_id: Required, version being delivered (> 0).
  • assignment_id: Optional, assignment that triggered delivery.
  • campaign_id: Optional, campaign context.
  • campaign_contact_id: Optional, per-contact campaign record.
  • contact_id: Optional, contact identity.
  • agent_id: Optional, agent handling the interaction (for agent-driven surveys).
  • call_id: Optional, voice-channel call identifier.
  • engagement_id: Optional, engagement (chat/SMS/etc.) identifier.
  • channel_type: Required, one of voice, whatsapp, sms, webchat, email.

Response​

Returns response_id, status (in_progress), and current_question.

Request​

Responses​

A successful response.