v1
latestSwagger 2.02026-08-04471124.2 KBsessions
post/sessions/
Request body
uuidstring uuid
Unique session identifier
campaign_uuidstring uuid required
status'not_started' | 'in_progress' | 'processing' | 'completed' | 'failed' | 'timeout'
started_atstring date-time nullable
last_activity_atstring date-time nullable
attempts_allowedinteger
attempts_countinteger
success_attempts_allowedinteger
success_attemptsinteger
closedboolean
email_capture_mode'none' | 'before_optional' | 'before_required' | 'after'
How to handle email capture when no Participant is linked
created_atstring date-time
Response
Created
uuidstring uuid
Unique session identifier
campaign_uuidstring uuid required
status'not_started' | 'in_progress' | 'processing' | 'completed' | 'failed' | 'timeout'
started_atstring date-time nullable
last_activity_atstring date-time nullable
attempts_allowedinteger
attempts_countinteger
success_attempts_allowedinteger
success_attemptsinteger
closedboolean
email_capture_mode'none' | 'before_optional' | 'before_required' | 'after'
How to handle email capture when no Participant is linked
created_atstring date-time