address_parameters

address parameter object data

Name

Type

Description

type

(mandatory)

String

The type of the address which can be added

HOME, BUSINESS, POBOX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5

postal_code

(optional)

String

The postal code of the address

From R14.2.0, only applicable for both CRM.COM and International address format

street_name

(mandatory on conditions)

String

The street name of the address

From R14.2.0, only applicable and mandatory for CRM.COM address format

street_number

(optional)

String

The street number of the address

From R14.2.0, only applicable for CRM.COM address format

floor

(optional)

Integer

The floor of the address

From R14.2.0, only applicable for CRM.COM address format

apartment_number

(optional)

String

The apartment number of the address

From R14.2.0, only applicable for CRM.COM address format

area

(optional)

String

The area of the address

From R14.2.0, only applicable for CRM.COM address format

town_city

(optional)

String

The town/city of the address

From R14.2.0, only applicable for both CRM.COM and International address format

district

(optional)

String

The district of the address

From R14.2.0, only applicable for both CRM.COM and International address format

municipality

(optional)

c

The municipality of the address

From R14.2.0, only applicable for both CRM.COM and International address format

country_identifier

(optional)

Country identifier

The country of the address. The allowed country identifier fields are the following:

Name	Type	Description
id (semi-optional)	String	The ID of the country
name (semi-optional)	String	The name of the country
alternative_code (semi-optional)	String	The alternative code of the retrieved country
two_character_code (semi-optional)	String	The two character code of the retrieved country
three_character_code (semi-optional)	String	The three character code of the retrieved country

From R14.2.0, only applicable for both CRM.COM and International address format

address_line_1

(mandatory on conditions)

String

The address line 1

Available from R14.2.0. Applicable and mandatory only for International address format

address_line_2

(mandatory on conditions)

String

The address line 2

Available from R14.2.0. Applicable only for International address format

state_province_county

(optional)

String

The state or province or county of the address.

Available from R14.2.0. Applicable only for International address format

po_box

(optional)

String

The PO box of the address

po_box_postal_code

(optional)

String

The PO box postal code of the address

care_of

(optional)

String

The care of person of the address

notes

(optional)

String

The notes of the address

udf_string_1

(optional)

String