Skip to main content

UpdateSurveyAssignment updates an existing campaign assignment.

PUT 
/api/v1/surveys/assignments/:id

Use this to swap in a newer survey version, change the trigger timing, toggle active to pause delivery without removing history, or adjust retry behaviour. Channel and campaign cannot be changed; remove and recreate the assignment for those.

Parameters​

  • id: Required, assignment ID (> 0).
  • survey_version_id: Optional, pin to a new version.
  • trigger_point: Optional, change trigger rule.
  • trigger_delay_seconds: Optional, change delay.
  • mandatory: Optional, toggle required completion.
  • max_attempts: Optional, adjust retry count.
  • active: Optional, toggle delivery on/off.

Request​

Responses​

A successful response.