Address API object

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

  • Builds an address object for a contact. A contact can contain multiple addresses objects.

    Parameters

    • Optional country: string

      Full country name

    • Optional country_code: string

      Two-letter country abbreviation

    • Optional state: string

      State abbreviation

    • Optional city: string

      City name

    • Optional street: string

      Street number and name

    • Optional zip: string

      ZIP code

    • Optional type: string

      Address type. Standard Values: HOME, WORK

    Returns Address

Properties

city?: string

The city of the address

country?: string

The country of the address

country_code?: string

The country code of the address

state?: string

The state of the address

street?: string

The street of the address

type?: string

The type of the address

zip?: string

The zip code of the address

Accessors

  • get _many(): true
  • Returns true

Methods

Generated using TypeDoc