Attributes

address
city
Example: Lebanon
country

Leave this field blank (absent, empty string, or null) 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 address blocks include 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.

postal_code
Example: 03766
state
Example: NH
street
Example: 123 Main St.

The street address may contain multiple lines.

company

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

contact_id
Example: c-###-####
external_id

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

file_as
Example: Tischler, Joe

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
Example: Joe and Mary

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

If a 'greeting' isn't included, one will be generated automatically, based on the contact's name.

name
Example: Joe and Mary Tischler

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

Example Object

{
   "address" : {
      "city" : "Lebanon",
      "country" : "",
      "postal_code" : "03766",
      "state" : "NH",
      "street" : "123 Main St."
   },
   "company" : null,
   "contact_id" : "c-###-####",
   "external_id" : null,
   "file_as" : "Tischler, Joe",
   "greeting" : "Joe and Mary",
   "name" : "Joe and Mary Tischler"
}