API V2
API V2
https://{{env}}.questionpro.com/a/api/v2/surveys/{{survey-id}}/emaillists/{{email-list-id}}/emails/{{address-id}}?apiKey={{apiKey}}
The value of environment {{env}} variable depends upon your datacenter. Refer to the Environment page for more details.
{
"emailAddress": "john.doe@emaildomain.com",
"firstname": "John",
"lastname": "Doe",
"custom1": "WA",
"custom2": "Product",
"custom3": "EID999",
"custom4": "",
"custom5": "",
"highCustomVariables": {
"custom8":"Product B",
"custom10":"Department ZZ"
}
}
curl --request PUT \
--url 'https://{{env}}.questionpro.com/a/api/v2/surveys/{{survey-id}}/emaillists/{{email-list-id}}/emails/{{address-id}}?apiKey={{apiKey}}' \
--header 'Content-Type: application/json' \
--data '{
{
"emailAddress": "john.doe@emaildomain.com",
"firstname": "John",
"lastname": "Doe",
"custom1": "WA",
"custom2": "Product",
"custom3": "EID999",
"custom4": "",
"custom5": "",
"highCustomVariables": {
"custom8":"Product B",
"custom10":"Department ZZ"
}
}'
import requests
url = "https://{{env}}.questionpro.com/a/api/v2/surveys/{{survey-id}}/emaillists/{{email-list-id}}/emails/{{address-id}}"
querystring = {"apiKey":"{{apiKey}}"}
payload = "{\"emailAddress\":\"john.doe@emaildomain.com\",\"firstname\":\"John\",\"lastname\":\"Doe\",\"custom1\":\"WA\",\"custom2\":\"Product\",\"custom3\":\"EID999\",\"custom4\":\"\",\"custom5\":\"\",\"highCustomVariables\":{\"custom8\":\"Product B\",\"custom10\":\"Department ZZ\"}}"
headers = {'Content-Type': 'application/json'}
response = requests.request("PUT", url, data=payload, headers=headers, params=querystring)
print(response.text)
{
"response": {
"addressID": 100000076,
"emailAddress": "john.doe@emaildomain.com",
"firstname": "John",
"lastname": "Doe",
"emailListID": 1000002,
"custom1": "WA",
"custom2": "Product",
"custom3": "EID999",
"custom4": "",
"custom5": "",
"creationDate": "Mon 23 Nov, 22:11:41 GMT 2020",
"highCustomVariables": {
"custom8": "Product B",
"custom10": "Department ZZ"
}
}
}
{
"$schema": "http://json-schema.org/draft-06/schema# ",
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"emailAddress": {
"type": "string",
"format": "email"
},
"firstname": {
"type": "string"
},
"highCustomVariables": {
"type": "object",
"properties": {
"custom10": {
"type": "string"
},
"custom8": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"custom10",
"custom8"
]
},
"custom3": {
"type": "string"
},
"custom4": {
"type": "string"
},
"custom1": {
"type": "string"
},
"custom2": {
"type": "string"
},
"creationDate": {
"type": "string"
},
"emailListID": {
"type": "integer"
},
"custom5": {
"type": "string"
},
"addressID": {
"type": "integer"
},
"lastname": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"firstname",
"highCustomVariables",
"creationDate",
"emailListID",
"addressID",
"lastname",
"emailAddress",
"custom3",
"custom4",
"custom1",
"custom2",
"custom5"
]
}
},
"additionalProperties": false,
"required": [
"response"
]
}
{
"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"
]
}