Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

Expand
titleaddress parameter object data
NameTypeDescription

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

Tip

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

Tip

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

street_number

(optional)

String

The street number of the address

Tip

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

floor

(optional)

Integer

The floor of the address

Tip

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

apartment_number

(optional)

String

The apartment number of the address

Tip

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

area

(optional)

String

The area of the address

Tip

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

town_city

(optional)

String

The town/city of the address

Tip

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

district

(optional)

String

The district of the address

Tip

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

municipality

(optional)

         

c

The municipality of the address

Tip

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

country_identifier

(optional)

Country identifier

Include Page
country_identifiercountry_identifier
Tip

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

Tip

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

address_line_2

(mandatory on conditions)

String

 The address line 2

Tip

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.

Tip

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 Expand
titleaddress parameter object data

From R14.2.0, the following object is applicable for CRM.COM Address Format

NameTypeDescription

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

street_name

(mandatory on conditions)

String

The street name of the address

street_number

(optional)

String

The street number of the address

 

floor

(optional)

Integer

The floor of the address

 

apartment_number

(optional)

String

The apartment number of the address

 

area

(optional)

String

The area of the address

 

town_city

(optional)

String

The town/city of the address

 

district

(optional)

String

The district of the address

 

municipality

(optional)

         

c

The municipality of the address

 

country_identifier

(optional)

Country identifier

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

Include Page
country_identifier
country_identifier

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)

StringThe notes of the address

udf_string_1

(optional)

String

User Defined Field of type String

udf_string_2

(optional)

String

User Defined Field of type String

udf_string_3

(optional)

String

User Defined Field of type String

udf_string_4

(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

String

User Defined Field of type String

udf_string_8

(optional)

String

User Defined Field of type String

udf_string_9

(optional)

String

User Defined Field of type String

udf_string_10

(optional)

String

User Defined Field of type String

udf_string_11

(optional)

String

User Defined Field of type String

udf_string_12

(optional)

String

User Defined Field of type String

udf_string_13

(optional)

String

User Defined Field of type String

udf_string_14

(optional)

String

User Defined Field of type String

udf_string_15

(optional)

String

User Defined Field of type String

udf_string_16

(optional)

String

User Defined Field of type String

udf_float_1

(optional)

Float

User Defined Field of type Float

udf_float_2

(optional)

Float

User Defined Field of type Float

udf_float_3

(optional)

Float

User Defined Field of type Float

udf_float_4

(optional)

Float

User Defined Field of type Float

udf_date_1

(optional)

Date

User Defined Field of type Date

udf_date_2

(optional)

Date

User Defined Field of type Date

udf_date_3

(optional)

Date

User Defined Field of type Date

udf_date_4

(optional)

Date

User Defined Field of type Date

 

From R14.2.0, the following object is applicable for International Address Format
NameTypeDescription

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

 

town_city

(optional)

String

The town/city of the address

country_identifier

(optional)

Country identifier

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

Include Page
country_identifier
country_identifier

address_line_1

(mandatory on conditions)

String

The address line 1

address_line_2

(mandatory on conditions)

String

 The address line 2

state_province_county

(optional)

String

The state or province or county of the address.

 

notes

(optional)

StringThe notes of the address

udf_string_1

(optional)

String

User Defined Field of type String

udf_string_2

(optional)

String

User Defined Field of type String

udf_string_3

(optional)

String

User Defined Field of type String

udf_string_4

(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

String

User Defined Field of type String

udf_string_8

(optional)

String

User Defined Field of type String

udf_string_9

(optional)

String

User Defined Field of type String

udf_string_10

(optional)

String

User Defined Field of type String

udf_string_11

(optional)

String

User Defined Field of type String

udf_string_12

(optional)

String

User Defined Field of type String

udf_string_13

(optional)

String

User Defined Field of type String

udf_string_14

(optional)

String

User Defined Field of type String

udf_string_15

(optional)

String

User Defined Field of type String

udf_string_16

(optional)

String

User Defined Field of type String

udf_float_1

(optional)

Float

User Defined Field of type Float

udf_float_2

(optional)

Float

User Defined Field of type Float

udf_float_3

(optional)

Float

User Defined Field of type Float

udf_float_4

(optional)

Float

User Defined Field of type Float

udf_date_1

(optional)

Date

User Defined Field of type Date

udf_date_2

(optional)

Date

User Defined Field of type Date

udf_date_3

(optional)

Date

User Defined Field of type Date

udf_date_4

(optional)

Date

User Defined Field of type Date

...