AddressType
stringType of address
Allowed values:MAILINGBUSINESSPHYSICAL
AddressV2
objectAddress identifier.
Example:550e8400-e29b-41d4-a716-446655440000
Type of address
Allowed values:MAILINGBUSINESSPHYSICAL
First line of the street address.
Example:123 Main St
Second line of the street address (suite, unit, etc.).
Example:Apt 4B
City.
Example:Denver
Two-letter US state code.
>= 2 characters<= 2 characters
Example:CO
ZIP code in 5-digit or ZIP+4 format.
Match pattern:^\d{5}(-\d{4})?$
Example:80202
County name.
Example:Denver
Country code (ISO alpha-2).
>= 2 characters<= 2 characters
Example:US
Date the person moved to this address (YYYY-MM-DD).
Example:2020-01-15
Whether this is the person’s preferred address.
Example:true
RFC3339 UTC timestamp when the address was created.
Example:2024-01-15T10:30:00Z
RFC3339 UTC timestamp when the address was last updated.
Example:2024-01-15T14:45:00Z
UpdateAddressRequest
objectType of address
Allowed values:MAILINGBUSINESSPHYSICAL
First line of the street address.
Example:123 Main St
Second line of the street address (suite, unit, etc.).
Example:Apt 4B
City.
Example:Denver
Two-letter US state code.
Example:CO
ZIP code in 5-digit or ZIP+4 format.
Match pattern:^\d{5}(-\d{4})?$
Example:80202
County name.
Example:Denver
Country code (ISO alpha-2).
Example:US
Date the person moved to this address (YYYY-MM-DD).
Example:2020-01-15
Whether this should be the preferred address. When true, any other preferred address for the same person or firm is automatically unset. Omitting or null is treated as false.
Default:false
CreateAddressRequest
objectType of address
Allowed values:MAILINGBUSINESSPHYSICAL
First line of the street address.
Example:123 Main St
Second line of the street address (suite, unit, etc.).
Example:Apt 4B
City.
Example:Denver
Two-letter US state code.
>= 2 characters<= 2 characters
Example:CO
ZIP code in 5-digit or ZIP+4 format.
Match pattern:^\d{5}(-\d{4})?$
Example:80202
County name.
Example:Denver
Country code (ISO alpha-2).
>= 2 characters<= 2 characters
Example:US
Date the person moved to this address (YYYY-MM-DD).
Example:2020-01-15
Whether this should be the person’s preferred address. When the person has no existing addresses, the server sets this to true regardless of the supplied value.
Default:false
PhoneType
stringThe type of phone
Allowed values:CELLBUSINESSRESIDENTFAX