Skip to main content

Batch create responses

POST 
/v3/responses/batch

Batch create responses

Request​

Body

    survey_id numberrequired

    ID of the survey

    responses

    object[]

    required

    Possible values: <= 200

  • Array [

    • contact_id number

    ID of the contact

    contact

    object

    Contact of the submission

    full_name string

    Possible values: <= 255 characters

    Full Name of contact

    phone string

    Possible values: <= 255 characters

    Phone number of the contact

    mobile string

    Possible values: <= 255 characters

    Mobile number of the contact

    email string

    Possible values: <= 255 characters

    Email of contact

    job_title string

    Possible values: <= 255 characters

    Job Title of the contact

    contact_type string

    Possible values: [contact, employee]

    Default value: contact

    Type of contact

    variables object
    trigger_workflow boolean

    Default value: true

    Should this response trigger workflow

    channel_id number

    ID of the channel

    meta_data

    object

    os string

    Possible values: <= 255 characters

    OS of the response

    browser string

    Possible values: <= 255 characters

    Browser of response

    time_zone string

    Possible values: <= 255 characters

    Time Zone of response

    browser_language string

    Possible values: <= 255 characters

    Browser Language of the response

    date_time date

    Date and Time of submission. Should be in the ISO format

    answers

    object[]

    required

  • Array [

    • question_id numberrequired

    ID of the question

    parent_question_id number

    ID of the parent question

    answer stringrequired

    Answer of question

    other_txt string

    Other Text Answer

    matrix_txt string[]

    Matrix Answer for Text Input

    matrix_int string[]

    Matrix Answer for Rating

    region_code string

    Possible values: <= 255 characters

    Region code of Answer

    time string

    Possible values: <= 255 characters

    Time of Answer

    time_zone string

    Possible values: <= 255 characters

    TimeZone of Answer

  • ]

  • ]

Responses​

Accepted

Schema

    token stringrequired

    Job ID for tracking the batch import process

    message stringrequired

    A message indicating the acceptance of the batch import request

Loading...