Get started

    API Endpoint

         "<datazapp api endpoint URL>"

An Email Append Service enriches your contact information by adding email addresses through a matching process with the 400 million Email database. It’s important to note that the matched emails are not verified; we recommend using our email verification API for that purpose.

To use this API, you need an API key. Please contact us at [email protected] to get your API key.

Email Append API Request

Query Parameters

Request                    
{
     "ApiKey": "Put your api key here",
     "AppendModule": "EmailAppend",
     "AppendType": 1,
     "Data": [
           {
               "FirstName": "GxxxxA",
               "LastName": "MxRxxx",
               "Address": "Px Bxx 5xx",
               "City": "AGxxxx",
               "Zip": "0x6x2"
           }
       ]
}

Parameter	Type	Required	Description
APIKey	String	Required	Issued by Datazapp Support.
AppendModule	String	Required	Value should be “EmailAppend.”
Append Type	String	Required	Valid values 1,2,3 1- Individual 2- household 3- Combined (Single column. individual priority, household 2nd pass)
Following parameters should be sent in Data Object in array format.
FirstName	String	Required	First name of the person.
LastName	String	Required	Last name of the person.
Address	String	Required	Valid United States postal address.
City	String	Required	City name.
Zip	String	Required	5-digit Zip code associated. Zip or Zip+4 is accepted.
AlterFirstName	String	Optional	Alternate first name of the person or 2nd name or spouse name, this will help with higher match rate.
AlterLastName	String	Optional	Alternate last name of the person or 2nd name or spouse name, this will help with higher match rate.
AlterAddress	String	Optional	Secondary address if available.
AlterCity	String	Optional	Secondary city name if available.
AlterZip	String	Optional	Secondary zip code.

Response

Query Parameters

                    

Response

Sample Response JSON Example:
{
    "header": {
        "Status": 0,
        "Message": null
    },
    "ResponseDetail": {
        "Token": "xxxxxx",
        "Data": null,
        "OrderAmount": "$x.xx",
        "Count": 501,
        "Message": "Your append request is accepted.
 Please check for status at <datazapp api endpoint URL>",
        "ProcessedTime": "221 milliseconds"
    },
    "Status": true,
    "Message": null
}

URL to check status and download data: "<datazapp api endpoint URL>"
(Post the following data with Token returned)

{
    "ApiKey": "Your API Key",
    "Token": "xxxxxx"
}

If the request is in process, it will reply:

{
    "ResponseDetail": {
        "Status": false,
        "Message": "Append request [xxxxxx] is in process!",
        "Data": null
    },
    "Status": true,
    "Message": null
}

If the request is processed, it will reply with the following JSON:

{
    "header": {
        "Status": 0,
        "Message": null
    },
    "ResponseDetail": {
        "App": 0,
        "Token": "xxxxxx",
        "Data": [
            {
                "Matched": true,
                "FirstName": "GxxxxA",
                "LastName": "MxRxxx",
                "Address": "Px Bxx 5xx",
                "City": "AGxxxx",
                "Zip": "0x6x2",
                "AlterFirstName": "",
                "AlterLastName": "",
                "AlterAddress": "",
                "AlterCity": "",
                "AlterZip": "",
                "Email": "a***3@g****l.com"
            }
        ],
        "OrderAmount": "$0.00",
        "Count": 2,
        "Message": null,
        "ProcessedTime": "In milliseconds"
    },
    "Status": true,
    "Message": null
}

Field	Type	Description
Following Parameters Should be send in Header:
Status	Integer	Indicate header status
Message	String	Indicate type of error
Following Parameters Should be send in ResponseDetails:
App
Token	String	System generated reference.
Following parameters should be sent in Data Object in Array format:
Matched	String	True=if matched , False =if not matched data
FirstName	String	First name (name of person in household)
LastName	String	Last name (name of person in household)
Address	String	Address of Individual from United States
City	String	City of Individual from United States.
Zip	String	Zip code associated. Zip or Zip+4 is accepted
AlterFirstName	String	Secondary First name (Alternate name of person in household, boosts match rate)
AlterLastName	String	Secondary Last name (Alternate name of person in household, boosts match rate)
AlterAddress	String	Secondary Address (Alternate Address of person in household, boosts match rate)
AlterCity	String	Secondary Address City (Alternate Address City of person in household, boosts match rate)
AlterZip	String	Secondary Address ZIP (Alternate Address ZIP of person in household, boosts match rate) Zip code associated. Zip or Zip+4 is accepted
Email	String	Email (Email of person)
OrderAmount	String	Amount of count
Count	String	Number of count
Message	String	Null
Status	String	True,False
Message	String	Null
ProcessedTime	String	Processing time
Status	String	TRUE
Message	String	TRUE

Errors

The API uses the following error codes:

Error Code	Meaning
Module does not exist.	The specified module does not exist or Invalid AppendModule Name.
User not found.	Invalid API Key or The user associated with the API key was not found
Getting 401 Error.	The user does not have access to this API
Append Request not found	Invalid Token: The specified append request could not be found
Improper JSON Data. Please check.	The JSON data in the request does not match the expected format.
It seems like API has an issue. Please contact Support.	There is an issue with the API. Contact the [email protected]