Post /surveys/{{survey-id}}/emaillists/{{email-list-id}}/emails

Example Request

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.


Authorization

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

Request Parameters

arrow_rightPath Parameters
survey-id integer
required
email-list-id integer
required

Request Body

arrow_rightPayload
application/json

                            [
                                {
                                    "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"
                                        	}
                                }
                                ]
                    

Example Code

arrow_rightcURL
Snippet copied successfully.
application/json

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"
    	}
    }
    ]'
                
arrow_rightPython
Snippet copied successfully.
application/json

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)

                    
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/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;

                    

Responses

arrow_rightExample
application/json

{
    "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"
}
                    
arrow_rightSchema
application/json

{
    "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"
}
                    
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"
  ]
}
                                

statusUrl

Use the statusUrl to check the status of the upload process.

Example Request

https://api.questionpro.{{env}}/a/api/v2/surveys/{{survey-id}}/emaillists/{{email-list-id}}/emails/{{process-id}}/status

Responses

arrow_rightStatus URL response
application/json

{
    "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"
}
                    
arrow_rightSchema
application/json

{
    "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"
}
                    
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"
  ]
}
                                
arrow_rightExample
application/json

{
    "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"
}
    

  • Expected values for "status" : Running | Error | Completed
  • The resultUrl will be available in the response once the "status" of the email address upload process is completed.
  • Note: The API requests made to the statusUrl does not consume your API calls limit.


resultUrl

  • Use the resultUrl to fetch the list of the email addresses uploaded.
  • By default, the response of resultUrl will contain all the email addresses which were uploaded successfully. But if there's a requirement to pull the email addresses which were not uploaded then use "?failedOnly=true" in the API endpoint.

Example Request

https://api.questionpro.{{env}}/a/api/v2/surveys/{{survey-id}}/emaillists/{{email-list-id}}/emails/{{process-id}}/result

Responses

arrow_rightResult URL response
application/json

{
    "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"
}                  
arrow_rightSchema
application/json

{
    "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"
}   
                    
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"
  ]
}
                                

resultUrl API endpoint with failedOnly Parameter

Example Request

https://api.questionpro.{{env}}/a/api/v2/surveys/{{survey-id}}/emaillists/{{email-list-id}}/emails/{{process-id}}/result?failedOnly=true

Responses

arrow_rightResult URL response with failedOnly=true
application/json

                        {
    "response": [
        {
            "emailAddress": "jane.doe@xyz",
            "reason": "Invalid email address"
        },
        {
            "emailAddress": "jane.doe.com",
            "reason": "Invalid email address"
        }
    ],
    "requestID": "ad9857bc0-0000-49dc-a384-15d6874dfdd02"
}
                        
arrow_rightSchema
application/json

                    {
    "response": [
        {
            "emailAddress": "jane.doe@xyz",
            "reason": "Invalid email address"
        },
        {
            "emailAddress": "jane.doe.com",
            "reason": "Invalid email address"
        }
    ],
    "requestID": "ad9857bc0-0000-49dc-a384-15d6874dfdd02"
}
                        
  
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"
  ]
}