Email Append API

Get Started

The Email Append API enriches your customer records by adding email addresses through a matching process against Datazapp’s email database.

Matched emails are not automatically verified. For deliverability validation, we recommend using Datazapp’s Email Verification API after appending emails.

To use this API, you’ll need an active API key. Contact Datazapp support or your account representative to request API access.

API Endpoint

Replace the placeholder below with your assigned Datazapp API endpoint URL.

Endpoint - you'll get this from your account manager

<datazapp api endpoint URL>

Email Append API Request

Submit your API key, append module, append type, and customer records in the request body.

JSON Request Body

{
  "ApiKey": "Put your api key here",
  "AppendModule": "EmailAppend",
  "AppendType": 3,
  "Data": [
    {
      "FirstName": "John",
      "LastName": "Doe",
      "Address": "123 Main St",
      "City": "Anytown",
      "Zip": "12345"
    }
  ]
}

Request Parameters

Parameter	Required	Type	Description
`ApiKey`	Yes	String	Your assigned Datazapp API key.
`AppendModule`	Yes	String	Use `EmailAppend`.
`AppendType`	Yes	Integer / String	Determines which email append method should be used.
`Data`	Yes	Array	Contains the customer records to process.
`FirstName`	Yes	String	First name of the person.
`LastName`	Yes	String	Last name of the person.
`Address`	Yes	String	Valid United States postal address.
`City`	Yes	String	City name.
`Zip`	Yes	String	5-digit ZIP code. ZIP+4 is also accepted.
`AlterFirstName`	No	String	Alternate first name, second name, or spouse name. This may help improve match rate.
`AlterLastName`	No	String	Alternate last name, second name, or spouse name. This may help improve match rate.
`AlterAddress`	No	String	Secondary address, when available.
`AlterCity`	No	String	Secondary city, when available.
`AlterZip`	No	String	Secondary ZIP code, when available.

AppendType Values

1 — Individual Returns individual-level email matches when available.

2 — Household Returns household-level email matches when available.

3 — Combined Single-column combined output. Individual match is prioritized first, with household as a second pass.

API Response

A successful response includes a header, system-generated token, returned data, appended email, matched count, order amount, and processing time.

JSON Response

{
  "header": {
    "Status": 0,
    "Message": null
  },
  "ResponseDetail": {
    "App": 0,
    "Token": "xxxxxx",
    "Data": [
      {
        "Matched": true,
        "FirstName": "John",
        "LastName": "Doe",
        "Address": "123 Main St",
        "City": "Anytown",
        "Zip": "12345",
        "AlterFirstName": "",
        "AlterLastName": "",
        "AlterAddress": "",
        "AlterCity": "",
        "AlterZip": "",
        "Email": "j***e@g****l.com"
      }
    ],
    "OrderAmount": "$0.03",
    "Count": 1,
    "Message": null,
    "ProcessedTime": "In milliseconds"
  },
  "Status": true,
  "Message": null
}

Response Fields

Field	Type	Description
`header.Status`	Integer	Indicates header status.
`header.Message`	String	Indicates error type, when applicable.
`ResponseDetail.App`	Integer	Application reference value returned by the system.
`ResponseDetail.Token`	String	System-generated reference token.
`ResponseDetail.Data`	Array	Returned append result records.
`Matched`	Boolean / String	Indicates whether the submitted record matched.
`FirstName`	String	First name associated with returned record.
`LastName`	String	Last name associated with returned record.
`Address`	String	United States postal address associated with returned record.
`City`	String	City associated with returned record.
`Zip`	String	ZIP or ZIP+4 associated with returned record.
`AlterFirstName`	String	Secondary or alternate first name, when available.
`AlterLastName`	String	Secondary or alternate last name, when available.
`AlterAddress`	String	Secondary or alternate address, when available.
`AlterCity`	String	Secondary or alternate city, when available.
`AlterZip`	String	Secondary or alternate ZIP, when available.
`Email`	String	Returned appended email address.
`OrderAmount`	String	Amount charged for returned matches.
`Count`	String / Integer	Number of matched records.
`ProcessedTime`	String	Total API processing time.
`Status`	Boolean / String	Indicates overall request status.
`Message`	String	Null when successful, or error detail when applicable.

Errors

The API may return one of the following error messages if the request cannot be completed.

Module does not exist. The specified module does not exist or the AppendModule name is invalid.

User not found. The API key is invalid 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. The specified append request could not be found or the token is invalid.

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 may be an issue with the API. Contact Datazapp support for assistance.