API V2

Survey keyboard_arrow_down

Post /users/{{user-id}}/surveys

Example Request

https://api.questionpro.{{env}}/a/api/v2/users/{{user-id}}/surveys

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

Request Parameters

arrow_rightPath Parameters
user-id integer
required

Request Body

arrow_rightPayload
application/json 

                         {
                            "name" : "New Survey",
                            "folderID" : 9876543,
                            "responseQuota":"100",
                            "abbs":true,
                            "saveAndContinue": false,
                            "inactiveText": "This survey has been deactivated by the owner.",
                            "expiryDate": "12/31/2023"
                        }

Example Code

arrow_rightcURL
Snippet copied successfully.
application/json 

curl --location 'https://api.questionpro.{{env}}/a/api/v2/users/{{user-id}}/surveys' \
--header 'Content-Type: application/json' \
--header 'api-key: {{api-key}}' \
--data '{
    "name" : "New Survey",
    "folderID" : 9876543,
    "responseQuota":"100",
    "abbs":true,
    "saveAndContinue": false,
    "inactiveText": "This survey has been deactivated by the owner.",
    "expiryDate": "12/31/2023"
    }'
arrow_rightPython
Snippet copied successfully.
application/json 

import requests
import json

url = "https://api.questionpro.{{env}}/a/api/v2/users/{{user-id}}/surveys"

payload = json.dumps({
  "name": "New Survey",
  "folderID": 9876543,
  "responseQuota": "100",
  "abbs": True,
  "saveAndContinue": False,
  "inactiveText": "This survey has been deactivated by the owner.",
  "expiryDate": "12/31/2023"
})
headers = {
  'Content-Type': 'application/json',
  'api-key': '{{api-key}}'
}

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

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

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.questionpro.{{env}}/a/api/v2/users/{{user-id}}/surveys',
  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 =>'{
    "name" : "New Survey",
    "folderID" : 9876543,
    "responseQuota":"100",
    "abbs":true,
    "saveAndContinue": false,
    "inactiveText": "This survey has been deactivated by the owner.",
    "expiryDate": "12/31/2023"
    }',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'api-key: {{api-key}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Responses

arrow_rightExample
application/json 

                         {
                          "response": {
                                    "surveyID": 1234567,
                                    "ownerID": 9587462,
                                    "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"
                        }
arrow_rightSchema
application/json
{
  "$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"
            ]
          }
        },
        "ownerID": {
          "type": "integer"
        },
        "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",
        "ownerID",
        "creationDate",
        "inactiveText",
        "folderID",
        "url",
        "expiryDate",
        "completedResponses",
        "name",
        "modifiedDate",
        "responseQuota",
        "hasScoringLogic",
        "saveAndContinue",
        "status",
        "abbs"
      ]
    },
    "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"
  ]
}