Phone Append API

Get Started

The Phone Append API allows you to submit customer contact records and receive appended phone data when a match is available.

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>

Phone Append API Request

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

JSON Request Body

{
  "ApiKey": "Your API key",
  "AppendModule": "PhoneAppendAPI",
  "AppendType": 3,
  "DncFlag": "false",
  "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 `PhoneAppendAPI`.
`AppendType`	Yes	Integer	Determines which phone data output you want returned.
`DncFlag`	Yes	String	Controls whether results should be filtered against Do Not Call records.
`Data`	Yes	Array	Contains the customer records to process.

AppendType Values

1 — Cellphone Returns cellphone data when available.

2 — Landline Returns landline or household phone data when available.

3 — Both, Single Column Returns both options in a single phone field, prioritizing cell phone when available.

5 — Both, Separate Columns Returns landline and cellphone data in separate fields.

DncFlag Values

1 or "true" Returns phones that are not on the Do Not Call list.

0 or "false" Returns all available phones, including phones on and not on DNC.

API Response

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

JSON Response

{
  "header": {
    "Status": 200,
    "Message": "Success"
  },
  "ResponseDetail": {
    "App": 0,
    "Token": "X****C",
    "Data": [
      {
        "PhoneType": "C",
        "Matched": true,
        "Phone": "4******5",
        "DoNotCall": "Y",
        "Tag": "",
        "FirstName": "John",
        "LastName": "Doe",
        "Address": "1******* **R",
        "City": "Anytown",
        "Zip": "12345",
        "AlterFirstName": "",
        "AlterLastName": "",
        "AlterAddress": "",
        "AlterCity": "",
        "AlterZip": ""
      }
    ],
    "OrderAmount": "$0.00",
    "Count": 1,
    "ProcessedTime": "221 milliseconds"
  }
}

Response Fields

Field	Type	Description
`Status`	Integer / String	Indicates request status.
`Message`	String	Indicates success message or error message.
`Token`	String	System-generated reference token.
`Data`	Array	Returned append results.
`Matched`	Boolean / String	Indicates whether a match was found.
`PhoneType`	String	Phone type. `C` = Cell Phone, `H` = Household Phone.
`Phone`	String	Returned phone number.
`DoNotCall`	String	Indicates whether the phone is on the Do Not Call list.
`Cell`	String	Returned cellphone number, when using applicable append type.
`CellDoNotCall`	String	Indicates whether the returned cellphone is on the Do Not Call list.
`FirstName`	String	First name associated with returned record.
`LastName`	String	Last name associated with returned record.
`Address`	String	United States postal address.
`City`	String	City associated with returned record.
`Zip`	String	ZIP or ZIP+4 associated with returned record.
`AlterFirstName`	String	Alternative first name, when available.
`AlterLastName`	String	Alternative last name, when available.
`AlterAddress`	String	Alternative address, when available.
`AlterCity`	String	Alternative city, when available.
`AlterZip`	String	Alternative ZIP, when available.
`OrderAmount`	String	Amount charged for returned matches.
`Count`	String / Integer	Quantity matched.
`ProcessedTime`	String	Total API processing time.

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.