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: <= 400

  • 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

    email string

    Possible values: <= 255 characters

    Email of contact. Can be optional only if anonymous contact feature is enabled.

    phone string

    Possible values: <= 255 characters

    Phone number of the contact

    mobile string

    Possible values: <= 255 characters

    Mobile number of the 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

    referenceId string

    Possible values: <= 255 characters

    Reference ID of the anonymous contact

    variables object
    trigger_workflow boolean

    Default value: true

    When true (the default), this response triggers its configured workflows — webhooks, survey rules, integrations, and notifications. Set it to false to import the response quietly, without firing any of them. We recommend sending the same value for every response in the batch. Note: marketplace (SparrowApps) events are gated at the batch level — if even one response has trigger_workflow set to false, marketplace events are skipped for the entire batch.

    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

    tags string[]

    Tags of response

    ip string

    Tags of response

    device_type string

    Possible values: <= 255 characters

    Device Type of response

    language string

    Possible values: <= 255 characters

    Language of response

    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...