API V2
API V2
https://api.questionpro.{{env}}/a/api/v2/surveys/{{survey-id}}/emaillists/{{email-list-id}}/emails
The value of environment {{env}} variable depends upon your datacenter. Refer to the Environment page for more details.
[
{
"emailAddress": "[email protected]",
"firstname": "Jane",
"lastname": "Doe",
"custom1": "WA",
"custom2": "Sales",
"custom3": "EID987",
"custom4": "",
"custom5": "",
"highCustomVariables": {
"custom8": "Product A",
"custom10": "Department X"
}
},
{
"emailAddress": "[email protected]",
"firstname": "John",
"lastname": "Doe",
"custom1": "WA",
"custom2": "Sales",
"custom3": "EID986",
"custom4": "",
"custom5": "",
"highCustomVariables": {
"custom8": "Product A",
"custom10": "Department Z"
}
}
]
curl --location 'https://api.questionpro.{{env}}/a/api/v2/surveys/{{survey-id}}/emaillists/{{email-list-id}}/emails' \
--header 'Content-Type: application/json' \
--header 'api-key: {{api-key}}' \
--data-raw '[
{
"emailAddress": "[email protected]",
"firstname": "Jane",
"lastname": "Doe",
"custom1": "WA",
"custom2": "Sales",
"custom3": "EID987",
"custom4": "",
"custom5": "",
"highCustomVariables": {
"custom8": "Product A",
"custom10": "Department X"
}
},
{
"emailAddress": "[email protected]",
"firstname": "John",
"lastname": "Doe",
"custom1": "WA",
"custom2": "Sales",
"custom3": "EID986",
"custom4": "",
"custom5": "",
"highCustomVariables": {
"custom8": "Product A",
"custom10": "Department Z"
}
}
]'
import requests
import json
url = "https://api.questionpro.{{env}}/a/api/v2/surveys/{{survey-id}}/emaillists/{{email-list-id}}/emails"
payload = json.dumps([
{
"emailAddress": "[email protected]",
"firstname": "Jane",
"lastname": "Doe",
"custom1": "WA",
"custom2": "Sales",
"custom3": "EID987",
"custom4": "",
"custom5": "",
"highCustomVariables": {
"custom8": "Product A",
"custom10": "Department X"
}
},
{
"emailAddress": "[email protected]",
"firstname": "John",
"lastname": "Doe",
"custom1": "WA",
"custom2": "Sales",
"custom3": "EID986",
"custom4": "",
"custom5": "",
"highCustomVariables": {
"custom8": "Product A",
"custom10": "Department Z"
}
}
])
headers = {
'Content-Type': 'application/json',
'api-key': '{{api-key}}'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api.questionpro.{{env}}/a/api/v2/surveys/{{survey-id}}/emaillists/{{email-list-id}}/emails',
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 =>'[
{
"emailAddress": "[email protected]",
"firstname": "Jane",
"lastname": "Doe",
"custom1": "WA",
"custom2": "Sales",
"custom3": "EID987",
"custom4": "",
"custom5": "",
"highCustomVariables": {
"custom8": "Product A",
"custom10": "Department X"
}
},
{
"emailAddress": "[email protected]",
"firstname": "John",
"lastname": "Doe",
"custom1": "WA",
"custom2": "Sales",
"custom3": "EID986",
"custom4": "",
"custom5": "",
"highCustomVariables": {
"custom8": "Product A",
"custom10": "Department Z"
}
}
]',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json',
'api-key: {{api-key}}'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
{
"response": {
"message": "Email address upload process has started successfully. You can retrieve the email list using the 'Get Email Addresses' API endpoint.",
"statusUrl": "https://api.questionpro.{{env}}/a/api/v2/surveys/{{survey-id}}/emaillists/{{email-list-id}}/emails/{{process-id}}/status"
},
"requestID": "2012fedc-e8ce-48ae-b800-6q5ce287987a7dje"
}
{
"response": {
"message": "Email address upload process has started successfully. You can retrieve the email list using the 'Get Email Addresses' API endpoint.",
"statusUrl": "https://api.questionpro.{{env}}/a/api/v2/surveys/{{survey-id}}/emaillists/{{email-list-id}}/emails/{{process-id}}/status"
},
"requestID": "2012fedc-e8ce-48ae-b800-6q5ce287987a7dje"
}
{
"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"
]
}
Use the statusUrl to check the status of the upload process. Following is the response format or the statusUrl:
{
"response": {
"status": "Completed",
"resultUrl": "https://api.questionpro.com/a/api/v2/surveys/{{survey-id}}/emaillists/{{email-list-id}}/emails/{{process-id}}/result"
},
"requestID": "as5g3f09-f83a-4002-804e-7a985e87170d"
}
{
"response": {
"status": "Completed",
"resultUrl": "https://api.questionpro.com/a/api/v2/surveys/{{survey-id}}/emaillists/{{email-list-id}}/emails/{{process-id}}/result"
},
"requestID": "as5g3f09-f83a-4002-804e-7a985e87170d"
}
{
"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"
]
}
{
"response": {
"status": "Completed",
"resultUrl": "https://api.questionpro.com/a/api/v2/surveys/{{survey-id}}/emaillists/{{email-list-id}}/emails/{{process-id}}/result"
},
"requestID": "as5g3f09-f83a-4002-804e-7a985e87170d"
}
Use the resultUrl to fetch the list of the email addresses uploaded. Following is the response format for the resultUrl:
{
"response": [
{
"addressID": 828312678,
"emailAddress": "[email protected]",
"firstname": "Jane",
"lastname": "Doe",
"custom1": "WA",
"custom2": "Sales",
"custom3": "EID987",
"custom4": "",
"custom5": "",
"creationDate": "Fri 14 Feb, 14:35:33 GMT 2024",
"highCustomVariables": {
"custom8": "Product A",
"custom10": "Department Z"
}
},
{
"addressID": 828312679,
"emailAddress": "[email protected]",
"firstname": "John",
"lastname": "Doe",
"custom1": "WA",
"custom2": "Sales",
"custom3": "EID986",
"custom4": "",
"custom5": "",
"creationDate": "Fri 14 Feb, 14:35:33 GMT 2024",
"highCustomVariables": {
"custom8": "Product A",
"custom10": "Department X"
}
}
],
"pagination": {
"perPage": 100,
"totalItems": 2,
"currentPage": 1,
"totalPages": 1,
"links": {
"self": "https://api.questionpro.com/a/api/v2/surveys/{{survey-id}}/emaillists/{{email-list-id}}/emails/{{process-id}}/result",
"prev": null,
"next": null,
"first": "https://api.questionpro.com/a/api/v2/surveys/{{survey-id}}/emaillists/{{email-list-id}}/emails/{{process-id}}/result?page=1&perPage=100",
"last": "https://api.questionpro.com/a/api/v2/surveys/{{survey-id}}/emaillists/{{email-list-id}}/emails/{{process-id}}/result?page=1&perPage=100"
}
},
"requestID": "c19xxec6-2003-4b97-a743-f08d3faef8f0"
}
{
"response": [
{
"addressID": 828312678,
"emailAddress": "[email protected]",
"firstname": "Jane",
"lastname": "Doe",
"custom1": "WA",
"custom2": "Sales",
"custom3": "EID987",
"custom4": "",
"custom5": "",
"creationDate": "Fri 14 Feb, 14:35:33 GMT 2024",
"highCustomVariables": {
"custom8": "Product A",
"custom10": "Department Z"
}
},
{
"addressID": 828312679,
"emailAddress": "[email protected]",
"firstname": "John",
"lastname": "Doe",
"custom1": "WA",
"custom2": "Sales",
"custom3": "EID986",
"custom4": "",
"custom5": "",
"creationDate": "Fri 14 Feb, 14:35:33 GMT 2024",
"highCustomVariables": {
"custom8": "Product A",
"custom10": "Department X"
}
}
],
"pagination": {
"perPage": 100,
"totalItems": 2,
"currentPage": 1,
"totalPages": 1,
"links": {
"self": "https://api.questionpro.com/a/api/v2/surveys/{{survey-id}}/emaillists/{{email-list-id}}/emails/{{process-id}}/result",
"prev": null,
"next": null,
"first": "https://api.questionpro.com/a/api/v2/surveys/{{survey-id}}/emaillists/{{email-list-id}}/emails/{{process-id}}/result?page=1&perPage=100",
"last": "https://api.questionpro.com/a/api/v2/surveys/{{survey-id}}/emaillists/{{email-list-id}}/emails/{{process-id}}/result?page=1&perPage=100"
}
},
"requestID": "c19xxec6-2003-4b97-a743-f08d3faef8f0"
}
{
"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"
]
}