Skip to main content

Create a section

POST 
/v1/surveys/:id/sections

Create a section

Request​

Path Parameters

    id numberrequired

Body

    name string
    description string

    properties

    object

    label string

    Default value: Continue

    sectionRandomise boolean

    displayLogic

    object

    logics

    object[]

  • Array [

    • join_condition string

    Possible values: [and, or]

    Default value: and

    type stringrequired

    Possible values: [param]

    comparator stringrequired

    Possible values: [isPassed, isNotPassed, startsWith, endsWith, contains, equalsString, doesNotContain, notEqualTo, lessThanForParam, greaterThanForParam]

    variable_id number
    value string

  • ]

    • questions

    object[]

    Possible values: <= 50

  • Array [

    • text stringrequired
    description string
    required boolean
    type stringrequired

    Possible values: [FileInput, TextInput, OpinionScale, MultiChoice]

    desc string

    Possible values: <= 10000 characters

    optionsStacked boolean
    randomized boolean
    multipleAnswers boolean
    img string

    Possible values: <= 2000 characters

    video string

    Possible values: <= 2000 characters

    audio string

    Possible values: <= 2000 characters

    tags string[]

    Possible values: Value must match regular expression /^[a-zA-Z ]*$/

    choices

    object[]

  • Array [

    • text string
    score number

  • ]

    • hasScore boolean
    other boolean
    allOfTheAbove boolean
    noneOfTheAbove boolean

    otherText

    object

    text string
    score number

    noneOfTheAboveText

    object

    text string
    score number

    allOfTheAboveText

    object

    text string

    properties

    object

    data

    object

    min string
    max string
    step number

    Possible values: [3, 4, 5, 6, 7, 8, 9, 10]

    wait number

    Possible values: [0, 1, 2, 3, 4, 5]

    type string

    Possible values: [SINGLE_LINE, MULTI_LINE, UNLIMITED, EXACT, RANGE]

    start number

    Possible values: [0, 1]

    fileTypes string[]

    Possible values: [image, doc, video, audio]

    minLimit number
    maxLimit number
    exactChoices number

    displayLogic

    object

    logics

    object[]

  • Array [

    • join_condition string

    Possible values: [and, or]

    Default value: and

    type stringrequired

    Possible values: [param]

    comparator stringrequired

    Possible values: [isPassed, isNotPassed, startsWith, endsWith, contains, equalsString, doesNotContain, notEqualTo, lessThanForParam, greaterThanForParam]

    variable_id number
    value string

  • ]

  • ]

Responses​

Successful

Schema

    string

Loading...