Email Append API Documentation

Introduction The TDG Email Append API enables enterprises to enrich fragmented customer records with verified email addresses in real-time. By matching physical markers against our identity graph, this email appending service provides a high-fidelity bridge for omnichannel marketing. Organizations can scale their outreach and optimize their email append cost by accessing direct-source data.

Authentication To access data, you must authenticate your requests using an API Key. By authenticating your requests with an API Key, you ensure secure and authorized access to our data services, allowing you to integrate our comprehensive and reliable data seamlessly into your applications and workflows.

Obtaining an API Key To obtain an API key, please contact us. Our team will respond and provide your API key within 24 hours. [Contact Us]

Including the API Key in Requests When interacting with our data services through APIs, SDKs, or command-line interfaces (CLI), it’s essential to include your API Key in the request. This API Key acts as a unique identifier that authenticates and authorizes your request to access our data.

Best Practices Use HTTPS to encrypt API Key transmissions over the network, preventing interception by unauthorized parties. Implement rate limiting and access controls based on API Key usage to manage and monitor access effectively.

Security HTTPS is required for all API requests. Request and response bodies are encoded as JSON.

CONVENTIONS

The base URL to send API requests is segregated into 3 categories.

Lookup: https://api.tdg1.io/v2/lookup
Append: https://api.tdg1.io/v2/append
Verify: https://api.tdg1.io/v2/verify

HTTPS is required for all API requests. The TDG API follows RESTful conventions when possible, with most operations performed via POST requests on database resources. Request and response bodies are encoded as JSON.

ENDPOINT SPECIFICATIONS

Email Append Append email addresses to your existing contact records

HEADERS

x-api-key (string) | required: Unique key obtained after contacting us.

BODY PARAMS

FName (string) | conditionally required: First name, 15 characters max. (Required if LName, Address1, and Zip are included).
LName (string) | conditionally required: Last name, 20 characters max. (Required if FName, Address1, and Zip are included).
Address1 (string) | conditionally required: Address line 1, 64 characters max. (Required if FName, LName and Zip are included).
Zip (string) | conditionally required: 5 digit numeric USPS zip code. (Required if FName, LName and Address are included).

				
					POST: https://testapi.tdg1.io/v3/append/email

				
					Sample Request

curl --location 'https://testapi.tdg1.io/v3/append/email' \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api_key>' \
--data '{
    "FName": "<Tom>",
    "LName": "<Smith>",
    "Address1": "<123 Main Street>",
    "Zip": "<12345>"
}'

				
					Sample Response

{
  "email": "Tom.Smith@Samplel.com",
  "trace": "a79835d0-506a-4c1a-a6f3-6c4b94f96a7e1"
}

DEVELOPER TOOLS (SDK & POSTMAN)

TDG SDK The TDG SDK is an open-source project designed to simplify the process of integrating our data services into your applications. By using the SDK, developers can easily access and utilize our API functionalities, ensuring a smooth and efficient development experience.

Access: Read Documentation on PyPI

Postman Collection Postman is a powerful tool that simplifies API development and testing. It allows you to easily create, test, and manage your API requests without writing any code. Using Postman with the TDG API provides a user-friendly way to explore and integrate our data services.

Run in Postman: [Import TDG Collection]
Technical Docs: View Documentation

API RESPONSE CODES

Understanding API response codes is essential for handling the outcomes of your API requests effectively. Here is a list of possible response codes and their descriptions:

HTTPS STATUS CODE	Description
200	Successful
204	No Records found
400	Missing required parameter(s)
401	The user is invalid (verify your credentials)
429	You have reached the maximum number of transactions allowed
440	Too many results. Please refine your search criteria
500	System error. Retry search, if failure continues, contact support

Need Technical Assistance?

Our engineering team is available for custom integration support and technical consultations.