Skip to content

Latest commit

 

History

History
27 lines (19 loc) · 2.43 KB

AddressCreate.md

File metadata and controls

27 lines (19 loc) · 2.43 KB
Raw

AddressCreate

Properties

Name Type Description Notes
customerReference String A customer reference string for customer look ups. [optional]
firstName String The first name associated with the address. An address must have either a first last name or a business name.
lastName String The last name associated with the address. An address must have either a first last name or a business name.
businessName String The business name associated with the address. An address must have either a first last name or a business name.
phoneNumber String The phone number associated with the address. [optional]
streetAddress String The primary street address information about the address.
extendedAddress String Additional street address information about the address such as, but not limited to, unit number or apartment number. [optional]
locality String The locality of the address. For US addresses, this corresponds to the city of the address.
administrativeArea String The locality of the address. For US addresses, this corresponds to the state of the address. [optional]
neighborhood String The neighborhood of the address. This field is not used for addresses in the US but is used for some international addresses. [optional]
borough String The borough of the address. This field is not used for addresses in the US but is used for some international addresses. [optional]
postalCode String The postal code of the address. [optional]
countryCode String The two-character (ISO 3166-1 alpha-2) country code of the address.
addressBook Boolean Indicates whether or not the address should be considered part of your list of addresses that appear for regular use. [optional]
validateAddress Boolean Indicates whether or not the address should be validated for emergency use upon creation or not. This should be left with the default value of `true` unless you have used the `/addresses/actions/validate` endpoint to validate the address separately prior to creation. If an address is not validated for emergency use upon creation and it is not valid, it will not be able to be used for emergency services. [optional]