API V2
API V2
https://{{env}}.questionpro.com/a/api/v2/users/{{user-id}}/surveys?apiKey={{apiKey}}
The value of environment {{env}} variable depends upon your datacenter. Refer to the Environment page for more details.
{
"name" : "New Survey",
"folderID" : 9876543,
"responseQuota":"100",
"abbs":true,
"saveAndContinue": false,
"inactiveText": "This Survey has been deactivated by the owner.",
"expiryDate": "12/30/2020"
}
curl --request POST \
--url 'https://{{env}}.questionpro.com/a/api/v2/users/{{user-id}}/surveys?apiKey={{apiKey}}' \
--header 'Content-Type: application/json' \
--data '{
"name" : "New Survey",
"folderID" : 9876543,
"responseQuota":"100",
"abbs":true,
"saveAndContinue": false,
"inactiveText": "This Survey has been deactivated by the owner.",
"expiryDate": "12/30/2020"
}'
import requests
url = "https://{{env}}.questionpro.com/a/api/v2/users/{{user-id}}/surveys"
querystring = {"apiKey":"{{apiKey}}"}
payload = "{\n\t\"name\":\"New Survey\",\n\t\"folderID\": 9876543\n,\n\t\"responseQuota\": 100\n,\n\t\"abbs\": true\n,\n\t\"saveAndContinue\": false\n,\n\t\"inactiveText\": "This Survey has been deactivated by the owner.\n",\n\t\"expiryDate\": 12/30/2020}"
headers = {'Content-Type': 'application/json'}
response = requests.request("POST", url, data=payload, headers=headers, params=querystring)
print(response.text)
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL =>"https://{{env}}.questionpro.com/a/api/v2/users/{{user-id}}/surveys?apiKey={{apiKey}}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "{\n\t\"name\":\"New Survey\",\n\t\"folderID\": 9876543\n,\n\t\"responseQuota\": 100\n,\n\t\"abbs\": true\n,\n\t\"saveAndContinue\": false\n,\n\t\"inactiveText\": "This Survey has been deactivated by the owner.\n",\n\t\"expiryDate\": 12/30/2020}",
CURLOPT_HTTPHEADER => array(
"Content-Type: application/json"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error # :" . $err;
} else {
echo $response;
}
?>
{
"response": {
"surveyID": 1234567,
"folderID": 9876543,
"name": "New Survey",
"url": "https://www.questionpro.com/t/XXXXXXXXXX",
"status": "Active",
"creationDate": "17 Nov, 2020 12:00:00 AM PST",
"modifiedDate": "17 Nov, 2020 03:19:07 AM PST",
"thankYouMessage": "Thank you for completing this survey.",
"responseQuota": 100,
"expiryDate": "12/30/2020",
"inactiveText": "This Survey has been deactivated by the owner.",
"abbs": true,
"saveAndContinue": false,
"surveyFinishMode": 15,
"completedText": "Thank you for completing this survey.",
"terminatedText": "Your profile does not fit our criteria. Thank you for your time",
"quotaOverlimitText": "Thank you for your time but we have already received the required responses.",
"hasScoringLogic": false,
"completedResponses": 0,
"surveyLanguages": [
{
"name": "English",
"contents": null,
"default": true
}
]
},
"requestID": "7012fedc-e8ce-48ae-b800-6q5ce287987a7dje"
}
{
"$schema": "http://json-schema.org/draft-06/schema# ",
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"surveyID": {
"type": "integer"
},
"completedText": {
"type": "string"
},
"surveyFinishMode": {
"type": "integer"
},
"quotaOverlimitText": {
"type": "string"
},
"thankYouMessage": {
"type": "string"
},
"terminatedText": {
"type": "string"
},
"surveyLanguages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"default": {
"type": "boolean"
},
"contents": {
"type": "null"
},
"name": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"default",
"name"
]
}
},
"creationDate": {
"type": "string"
},
"inactiveText": {
"type": "string"
},
"folderID": {
"type": "integer"
},
"url": {
"type": "string"
},
"expiryDate": {
"type": "string"
},
"completedResponses": {
"type": "integer"
},
"name": {
"type": "string"
},
"modifiedDate": {
"type": "string"
},
"responseQuota": {
"type": "integer"
},
"hasScoringLogic": {
"type": "boolean"
},
"saveAndContinue": {
"type": "boolean"
},
"status": {
"type": "string"
},
"abbs": {
"type": "boolean"
}
},
"additionalProperties": false,
"required": [
"surveyID",
"completedText",
"surveyFinishMode",
"quotaOverlimitText",
"thankYouMessage",
"terminatedText",
"surveyLanguages",
"creationDate",
"inactiveText",
"folderID",
"url",
"expiryDate",
"completedResponses",
"name",
"modifiedDate",
"responseQuota",
"hasScoringLogic",
"saveAndContinue",
"status",
"abbs"
]
},
"requestID": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"response",
"requestID"
]
}
{
"response": {
"error": {
"docs": www.questionpro.com/api/error-codes.html
"name": "BAD_REQUEST",
"httpStatusCode": 400,
"id" : "1000",
"message": "Invalid URL parameters",
"resourceUrl":"resource_url"
}
}
}
{
"$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"
]
}
{
"response": {
"error": {
"docs": www.questionpro.com/api/error-codes.html
"name": "UNAUTHORIZED",
"httpStatusCode": 401,
"id" : "1010",
"message": "Incorrect API Key",
"resourceUrl":"resource_url"
}
}
}
{
"$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"
]
}
{
"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"
}
}
}
{
"$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"
]
}
{
"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"
}
}
}
{
"$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"
]
}
{
"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"
}
}
}
{
"$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"
]
}