Update Email Address List | QuestionPro API Reference Document

Put /surveys/{{survey-id}}/emaillists/{{email-list-id}}/emails/{{address-id}}

Example Request


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

The value of environment {{env}} variable depends upon your datacenter. Refer to the Environment page for more details.

Authorization

Security - API Key

Name : api-key

required

Location : Request Header

Type : string

Request Parameters

Path Parameters

survey-id integer

required

email-list-id integer

required

address-id integer

required

Request Body

Payload

application/json


                         {
                            "emailAddress": "[email protected]",
                            "firstname": "John",
                            "lastname": "Doe",
                            "custom1": "WA",
                            "custom2": "Product",
                            "custom3": "EID999",
                            "custom4": "",
                            "custom5": "",
                            "highCustomVariables": {
                                "custom8":"Product B",
                                "custom10":"Department ZZ"
                            }
                        }

Example Code

cURL

Snippet copied successfully.

application/json


curl --location --request PUT 'https://api.questionpro.{{env}}/a/api/v2/surveys/{{survey-id}}/emaillists/{{email-list-id}}/emails/{{address-id}}' \
--header 'Content-Type: application/json' \
--header 'api-key: {{api-key}}' \
--data-raw ' {
        "emailAddress": "[email protected]",
        "firstname": "John",
        "lastname": "Doe",
        "custom1": "WA",
        "custom2": "Product",
        "custom3": "EID999",
        "custom4": "",
        "custom5": "",
         "highCustomVariables": {
            "custom8":"Product B",
            "custom10":"Department ZZ"
        }
    }'

Python

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/{{address-id}}"

payload = json.dumps({
  "emailAddress": "[email protected]",
  "firstname": "John",
  "lastname": "Doe",
  "custom1": "WA",
  "custom2": "Product",
  "custom3": "EID999",
  "custom4": "",
  "custom5": "",
  "highCustomVariables": {
    "custom8": "Product B",
    "custom10": "Department ZZ"
  }
})
headers = {
  'Content-Type': 'application/json',
  'api-key': '{{api-key}}'
}

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

print(response.text)

PHP - 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/{{address-id}}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'PUT',
  CURLOPT_POSTFIELDS =>' {
        "emailAddress": "[email protected]",
        "firstname": "John",
        "lastname": "Doe",
        "custom1": "WA",
        "custom2": "Product",
        "custom3": "EID999",
        "custom4": "",
        "custom5": "",
         "highCustomVariables": {
            "custom8":"Product B",
            "custom10":"Department ZZ"
        }
    }',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'api-key: {{api-key}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Responses

Example

application/json


                    {
                        "response": {
                            "addressID": 100000076,
                            "emailAddress": "[email protected]",
                            "uniqueSurveyUrl": "https://questionpro.com/a/TakeSurvey?tt=55a5w5aNjSAFyuKTt",
                            "firstname": "John",
                            "lastname": "Doe",
                            "city": "Austin",
                            "ip": "14.18.22.13",
                            "emailListID": 1000002,
                            "custom1": "WA",
                            "custom2": "Product",
                            "custom3": "EID999",
                            "custom4": "",
                            "custom5": "",
                            "creationDate": "Wed 11 Jul, 09:44:06 GMT 2018",
                            "unsubscribeEmailTimeStamp": "Mon 30 Jul, 20:10:25 GMT 2018",
                            "highCustomVariables": {
                                "custom8": "Product B",
                                "custom10": "Department ZZ",
                                "custom12": "Yo2"
                            }
                        },
                        "requestID": "2012fedc-e8ce-48ae-b800-6q5ce287987a7dje"
                    }

Schema

application/json

{
  "$schema": "http://json-schema.org/draft-06/schema# ",
  "type": "object",
  "properties": {
    "response": {
      "type": "object",
      "properties": {
        "firstname": {
          "type": "string"
        },
        "city": {
          "type": "string"
        },
        "ip": {
          "type": "string",
          "format": "ipv4"
        },
        "highCustomVariables": {
          "type": "object",
          "properties": {
            "custom10": {
              "type": "string"
            },
            "custom12": {
              "type": "string"
            },
            "custom8": {
              "type": "string"
            }
          },
          "additionalProperties": false,
          "required": [
            "custom10",
            "custom12",
            "custom8"
          ]
        },
        "creationDate": {
          "type": "string"
        },
        "emailListID": {
          "type": "integer"
        },
        "addressID": {
          "type": "integer"
        },
        "lastname": {
          "type": "string"
        },
        "emailAddress": {
          "type": "string",
          "format": "email"
        },
        "custom3": {
          "type": "string"
        },
        "custom4": {
          "type": "string"
        },
        "uniqueSurveyUrl": {
          "type": "string"
        },
        "custom1": {
          "type": "string"
        },
        "custom2": {
          "type": "string"
        },
        "unsubscribeEmailTimeStamp": {
          "type": "string"
        },
        "custom5": {
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "firstname",
        "city",
        "ip",
        "highCustomVariables",
        "creationDate",
        "emailListID",
        "addressID",
        "lastname",
        "emailAddress",
        "custom3",
        "custom4",
        "uniqueSurveyUrl",
        "custom1",
        "custom2",
        "unsubscribeEmailTimeStamp",
        "custom5"
      ]
    },
    "requestID": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "response",
    "requestID"
  ]
}

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

Schema

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

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

Schema

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

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

Schema

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

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

Schema

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

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

Schema

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

Introduction

Organization

Department

User

Folders

Survey

Blocks

Questions

Answers

Email Lists

Email List Addresses

Email Templates

Send Survey

Schedule Invitation

Export Batch

Responses

Datapad

Response Statistics

Images

Webhooks

Example Request

Authorization

Request Parameters

Request Body

Example Code

Responses