Add a Contact
Contacts API

Body Parameters

city

company

The contact's company, church, or other organization. It will be printed beneath the name and above the street address.

country

Leave the country blank if the contact is in the United States.

For non-US addresses, use the English name of the country (e.g. Germany rather than Deutschland). Place other elements of the address in the city, state, and postal_code fields normally.

For example, even though German addresses place the postal code before the city name, keep the city in the city field and the postal code in the postal_code field. Our software automatically reformats international addresses as needed when printing envelopes.

external_id

Use this field to store your application's identifier for this contact.

file_as

The name we should use when showing this contact in a list. It is usually in the format LastName, FirstName for individuals, or just the regular name for companies and churches.

If the file_as parameter is not included, one will be generated automatically, based on the contact's name.

greeting

The name we should use in the first line of a mail-merged letter, usually following the word "Dear".

If the greeting parameter is not included, one will be generated automatically, based on the contact's name.

name

The contact's full name, as it should appear on the first line of an envelope.

postal_code

state

street

The street address may contain multiple lines

Example Request

Successful Response

Error Responses

400 contacts.missing_name

The contact must have a name or company.

400 contacts.upload_body_missing

The request did not contain any content

400 contacts.upload_insufficient_address

The contact does not appear to have a mailing address (at least one of street or city must be filled in).

400 contacts.upload_invalid_address

The contact contains an address attribute that isn't a JSON object.

400 contacts.upload_missing_address

The one contact is missing an address attribute.

400 contacts.upload_missing_name

The contact is missing a name or company.

412 contacts.upload_invalid_content

The content must be a JSON object.

412 contacts.upload_invalid_format

The content must be a JSON file.

412 contacts.upload_missing_contact_attribute

The JSON file must contain a contact object.

500 contacts.error_creating_record

There was a database error on our end when creating the contact.