API V2
Post /micropanel/batches

Example Request

https://api.questionpro.{{env}}/a/api/v2/micropanel/batches

The request body requires template language ID and Survey Language ID as an input. So, in order to have that, please refer this Link


The value of environment {{env}} variable depends upon your datacenter. Refer to the Environment page for more details.


Authorization

arrow_rightSecurity - API Key
Name : api-key
required
Location : Request Header
Type : string

Some pointers

  1. In order to fetch the templateID, use this API
  2. The parameter filterType can contain any of the integer value from 1-3. Where

    • 1- DEFAULT_FILTER_TYPE (survey invite will be sent to all verified members)

      Example: "recipients": { "filterType": 1 }

    • 2- EMAIL_FILTER_TYPE (survey invite will be sent to only a particular member)

      Example: "recipients": { "filterType": 2, "emailAddress": "[email protected]" }

    • 3- EXISTING_FILTER_TYPE (survey invite will be sent to existing filter selected)

      Example: "recipients": { "filterType": 3, "existingFilterID" : 145 }

In order to fetch the existingFilterID, please refer API

Request Body

arrow_rightPayload
application/json 

                    {
                        "compose": {
                                "surveyID": 11372241,
                                "surveyAlias": "",
                                "surveyLength": 8,
                                "surveyLanguageID": 486,
                                "templateID": 118632,
                                "templateLanguageID": 1,
                                "allowMultipleResponses": true,
                                "incentives": {
                                  "completionPoints": 20,
                                  "quotaPoints": 30,
                                  "terminationPoints": 40
                                }
                        },
                        "recipients": {
                                "filterType": 2,
                                "emailAddress": "[email protected]",
                        },
                        "send": {
                                "deliveryOptions": {
                                      "automaticClosure": {
                                        "enabled": true,
                                        "closureDateTime": "12/10/2023 13:43",
                                        "responseQuota": 10
                                        }
                                },
                                    "notification": {
                                      "enableEmailInvitation": false
                                    }
                                }
                    }
arrow_rightInput Schema
surveyID integer
It should be survey id which is accessible by panel owner
templateID integer
Refer Point 1
allowMultipleResponses boolean
By default it will be false.
filterType integer (1-3)
Refer Point 2
closureDateTime timestamp
MM/dd/yyyy HH:mm (24 hours format is used)
enableEmailInvitation boolean
By default it will be false.

Example Code

arrow_rightcURL
Snippet copied successfully.
application/json 

            curl --location 'https://api.questionpro.com/a/api/v2/micropanel/batches' \
            --header 'Content-Type: application/json' \
            --header 'api-key: {{api-key}}' \
            --data-raw '{
    "compose": {
            "surveyID": 11372241,
            "surveyAlias": "",
            "surveyLength": 8,
            "surveyLanguageID": 486,
            "templateID": 118632,
            "templateLanguageID": 1,
            "allowMultipleResponses": true,
            "incentives": {
              "completionPoints": 20,
              "quotaPoints": 30,
              "terminationPoints": 40
            }
    },
    "recipients": {
            "filterType": 2,
            "emailAddress": "[email protected]"
    },
    "send": {
            "deliveryOptions": {
                  "automaticClosure": {
                    "enabled": true,
                    "closureDateTime": "12/10/2023 13:43",
                    "responseQuota": 10
                    }
            },
                "notification": {
                  "enableEmailInvitation": false
                }
            }
}'
arrow_rightPython
Snippet copied successfully.
application/json 

            import requests
import json

url = "https://api.questionpro.com/a/api/v2/micropanel/batches"

payload = json.dumps({
  "compose": {
    "surveyID": 11372241,
    "surveyAlias": "",
    "surveyLength": 8,
    "surveyLanguageID": 486,
    "templateID": 118632,
    "templateLanguageID": 1,
    "allowMultipleResponses": True,
    "incentives": {
      "completionPoints": 20,
      "quotaPoints": 30,
      "terminationPoints": 40
    }
  },
  "recipients": {
    "filterType": 2,
    "emailAddress": "[email protected]"
  },
  "send": {
    "deliveryOptions": {
      "automaticClosure": {
        "enabled": True,
        "closureDateTime": "12/10/2023 13:43",
        "responseQuota": 10
      }
    },
    "notification": {
      "enableEmailInvitation": False
    }
  }
})
headers = {
  'Content-Type': 'application/json',
  'apiKey': '{{api-key}}'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)
arrow_rightPHP
Snippet copied successfully.
application/json 

      <?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.questionpro.com/a/api/v2/micropanel/batches',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{
    "compose": {
            "surveyID": 11372241,
            "surveyAlias": "",
            "surveyLength": 8,
            "surveyLanguageID": 486,
            "templateID": 118632,
            "templateLanguageID": 1,
            "allowMultipleResponses": true,
            "incentives": {
              "completionPoints": 20,
              "quotaPoints": 30,
              "terminationPoints": 40
            }
    },
    "recipients": {
            "filterType": 2,
            "emailAddress": "[email protected]"
    },
    "send": {
            "deliveryOptions": {
                  "automaticClosure": {
                    "enabled": true,
                    "closureDateTime": "12/10/2023 13:43",
                    "responseQuota": 10
                    }
            },
                "notification": {
                  "enableEmailInvitation": false
                }
            }
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'apiKey: {{api-key}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Responses

arrow_rightExample
application/json 

    {
    "response": {
        "campaignBatchID": 1400,
        "message": "Invitation request submitted successfully. Please note down the campaign batchID to check the progress."
    },
    "requestID": "136719be-a035-4cd1-b78e-1491822f28e3"
}
arrow_rightSchema
application/json
{
  "$schema": "http://json-schema.org/draft-06/schema# ",
  "type": "object",
  "properties": {
    "response": {
      "type": "object",
      "properties": {
        "campaignBatchID": {
          "type": "integer"
        },
        "message": {
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "campaignBatchID",
        "message"
      ]
    },
    "requestID": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "response",
    "requestID"
  ]
}
arrow_right400 example
application/json

{
    "response": {
     "error": {
         "docs": www.questionpro.com/api/error-codes.html
         "name": "BAD_REQUEST",
         "httpStatusCode": 400,
         "id" : "1000",
         "message": "Invalid URL parameters",
         "resourceUrl":"resource_url"
        }
    }
}
arrow_rightSchema
application/json

{
  "$schema": "http://json-schema.org/draft-06/schema#                                 ",
  "type": "object",
  "properties": {
    "response": {
      "type": "object",
      "properties": {
        "error": {
          "type": "object",
          "properties": {
            "docs": {
              "type": "string"
            },
            "resourceUrl": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "id": {
              "type": "string"
            },
            "message": {
              "type": "string"
            },
            "httpStatusCode": {
              "type": "integer"
            }
          },
          "additionalProperties": false,
          "required": [
            "docs",
            "resourceUrl",
            "name",
            "id",
            "message",
            "httpStatusCode"
          ]
        }
      },
      "additionalProperties": false,
      "required": [
        "error"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "response"
  ]
}
arrow_right401 example
application/json

{
    "response": {
     "error": {
         "docs": www.questionpro.com/api/error-codes.html
         "name": "UNAUTHORIZED",
         "httpStatusCode": 401,
         "id" : "1010",
         "message": "Incorrect API Key",
         "resourceUrl":"resource_url"
        }
    }
}
arrow_rightSchema
application/json

{
  "$schema": "http://json-schema.org/draft-06/schema#                                 ",
  "type": "object",
  "properties": {
    "response": {
      "type": "object",
      "properties": {
        "error": {
          "type": "object",
          "properties": {
            "docs": {
              "type": "string"
            },
            "resourceUrl": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "id": {
              "type": "string"
            },
            "message": {
              "type": "string"
            },
            "httpStatusCode": {
              "type": "integer"
            }
          },
          "additionalProperties": false,
          "required": [
            "docs",
            "resourceUrl",
            "name",
            "id",
            "message",
            "httpStatusCode"
          ]
        }
      },
      "additionalProperties": false,
      "required": [
        "error"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "response"
  ]
}
arrow_right403 example
application/json

{
    "response": {
     "error": {
         "docs": www.questionpro.com/api/error-codes.html
         "name": "FORBIDDEN",
         "httpStatusCode": 403,
         "id" : "1013",
         "message": "The user does not have permission to access the resource",
         "resourceUrl":"resource_url"
        }
    }
}
arrow_rightSchema
application/json

{
  "$schema": "http://json-schema.org/draft-06/schema#                                 ",
  "type": "object",
  "properties": {
    "response": {
      "type": "object",
      "properties": {
        "error": {
          "type": "object",
          "properties": {
            "docs": {
              "type": "string"
            },
            "resourceUrl": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "id": {
              "type": "string"
            },
            "message": {
              "type": "string"
            },
            "httpStatusCode": {
              "type": "integer"
            }
          },
          "additionalProperties": false,
          "required": [
            "docs",
            "resourceUrl",
            "name",
            "id",
            "message",
            "httpStatusCode"
          ]
        }
      },
      "additionalProperties": false,
      "required": [
        "error"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "response"
  ]
}
arrow_right404 example
application/json

{
    "response": {
     "error": {
         "docs": www.questionpro.com/api/error-codes.html
         "name": "NOT_FOUND",
         "httpStatusCode": 404,
         "id" : "1040",
         "message": "The resource that you're trying to access doesn't exist",
         "resourceUrl":"resource_url"
        }
    }
}
arrow_rightSchema
application/json

{
  "$schema": "http://json-schema.org/draft-06/schema#                                 ",
  "type": "object",
  "properties": {
    "response": {
      "type": "object",
      "properties": {
        "error": {
          "type": "object",
          "properties": {
            "docs": {
              "type": "string"
            },
            "resourceUrl": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "id": {
              "type": "string"
            },
            "message": {
              "type": "string"
            },
            "httpStatusCode": {
              "type": "integer"
            }
          },
          "additionalProperties": false,
          "required": [
            "docs",
            "resourceUrl",
            "name",
            "id",
            "message",
            "httpStatusCode"
          ]
        }
      },
      "additionalProperties": false,
      "required": [
        "error"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "response"
  ]
}
arrow_right500 example
application/json

{
    "response": {
     "error": {
         "docs": www.questionpro.com/api/error-codes.html
         "name": "INTERNAL_SERVER_ERROR",
         "httpStatusCode": 500,
         "id" : "1026",
         "message": "We are not able to process your request",
         "resourceUrl":"resource_url"
        }
    }
}
arrow_rightSchema
application/json

{
  "$schema": "http://json-schema.org/draft-06/schema#                                 ",
  "type": "object",
  "properties": {
    "response": {
      "type": "object",
      "properties": {
        "error": {
          "type": "object",
          "properties": {
            "docs": {
              "type": "string"
            },
            "resourceUrl": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "id": {
              "type": "string"
            },
            "message": {
              "type": "string"
            },
            "httpStatusCode": {
              "type": "integer"
            }
          },
          "additionalProperties": false,
          "required": [
            "docs",
            "resourceUrl",
            "name",
            "id",
            "message",
            "httpStatusCode"
          ]
        }
      },
      "additionalProperties": false,
      "required": [
        "error"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "response"
  ]
}