Contacts

Manage contacts that you can mail to. Test mode addresses will always have a verified status. In live mode, they may be verified, corrected, or failed. Addresses that fail to be corrected are likely undeliverable, but you can still send to them if you want to.

For test mode contacts, you have the ability to assert the addressStatus of the contact by passing specific values to the description field. To receive an addressStatus of failed, the description of the contact should be a string with the exact value test failed. For an addressStatus value of corrected, the description of the contact should be a string with the exact value test corrected.

Our address correction engine will often be able to fix missing postal/ZIP codes, city names, and also append ZIP+4. It is SERP (Canada Post) and CASS (USPS) certified, so you can rest assured that if an address is verified, we can deliver to it.

Contact Response

Name	Type	Description
id	string	A unique ID prefixed with contact_
object	string	Always contact
live	boolean	true if this is a live mode contact else false
description	string or null	Optional line describing the contact
addressLine1	string	First line of address
addressLine2	string or null	Second line of address
provinceOrState	string or null	Province or state of address
postalOrZip	string or null	Postal or ZIP code of address
country	string or null	ISO 3611-1 country code of address. deprecated
countryCode	string or null	ISO 3611-1 country code of address
addressStatus	string	One of verified, corrected, or failed
firstName	string or null	First name or full name of contact
lastName	string or null	Last name of contact
email	string or null	Email address
phoneNumber	string or null	Phone number
companyName	string or null	Company name of contact
jobTitle	string or null	Job title of contact
metadata	object or null	See metadata