| Name | Description | Type | Additional information |
|---|---|---|---|
| AddressID |
Set to 0 to create a new address. Provide an existing AddressID to update it. |
integer |
None. |
| AddressTypeID |
Required. Address type. Accepts single-character ID or full name: M / Mailing, B / Billing, G / Garage, L / Location/Property. |
string |
None. |
| Line1 |
Required. Street address line 1. Max 255 characters. |
string |
None. |
| Line2 |
Street address line 2. Optional. Max 255 characters. |
string |
None. |
| City |
Required. City name. Max 255 characters. |
string |
None. |
| State |
State or province. For USA and CAN, must match a known 2-character code or full name (e.g. FL or Florida, ON or Ontario). For other countries, unrecognised values are stored as Province. |
string |
None. |
| County |
County name. Optional. Max 255 characters. |
string |
None. |
| CountryCode |
Required on add. 3-character country code (e.g. USA, CAN) or full country name (e.g. United States, Canada). |
string |
None. |
| Province |
Province or region for non-USA/CAN addresses. Optional. Max 255 characters. |
string |
None. |
| Zip |
Required. ZIP or postal code. Numbers only (5 digits) or ZIP+4 format (9 digits, e.g. 12345-6789). Max 10 characters. |
string |
None. |
| Notes |
Optional notes about the address. |
string |
None. |
| isPreferred |
Whether this is the preferred address for the contact. If multiple addresses in the request have isPreferred = true, only the last one wins. |
boolean |
None. |