GET contact_information/show

This method returns information related with a contact information. Single contact information is returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

contact_information_identifier

(mandatory)

Identifier

The identifier of the contact information that should be returned as a result. The allowed contact information identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the contact information

id_number

(semi-optional)

String

The ID number of the contact information

Applicable only for contact information that represent PERSON

passport_number

(semi-optional)

String

The passport number of the contact information

Applicable only for contact information that represent PERSON

social_security_number

(semi-optional)

String

The social security number of the contact information

Applicable only for contact information that represent PERSON

vat_registration_number

(semi-optional)

String

The VAT registration number of the contact information

Applicable only for contact information that represent COMPANY

registration_number

(semi-optional)

String

The registration number of the contact information

Applicable only for contact information that represent COMPANY

Available from CRM.COM R14.0.0

fields_set

(optional)

List of Strings, comma separated

A list of fields that should be included in the results. If not specified then all the available fields will be returned

Restrictions

It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Name	Type	Description
id	String	The ID of the retrieved contact information
type	String	The type of the retrieved contact information which can be PERSON or COMPANY
life_cycle_state	String	The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL
name	String	The full name of the retrieved contact information
title	String	The title of the retrieved contact information
first_name	String	The first name of the retrieved contact information
middle_name	String	The middle name of the retrieved contact information
last_name	String	The last name of the retrieved contact information
company_name	Sting	The company name of the retrieved contact information
notes	String	Notes for the contact information
organizational_unit	Integer	Indicates whether a contacts belongs to an organisational unit or not
preferred_language	String	The Contact Information's preferred language. The available values are: ARA DAN ENG EST FIN FRA DEU ELL JPN VIE MAL IND TAI LAV LIT NNO POL POR RUS SPA SWE UKR CMN TGL HIN CUSTOM1 CUSTOM2 CUSTOM3 CUSTOM4 CUSTOM5 CUSTOM6 CUSTOM7 CUSTOM8 Available from CRM.COM R12.0.0
udf_string_1	String	User Defined Field of type String
udf_string_2	String	User Defined Field of type String
udf_string_3	String	User Defined Field of type String
udf_string_4	String	User Defined Field of type String
udf_string_5	String	User Defined Field of type String
udf_string_6	String	User Defined Field of type String
udf_string_7	String	User Defined Field of type String
udf_string_8	String	User Defined Field of type String
udf_string_9	String	User Defined Field of type String
udf_string_10	String	User Defined Field of type String
udf_string_11	String	User Defined Field of type String
udf_string_12	String	User Defined Field of type String
udf_string_13	String	User Defined Field of type String
udf_string_14	String	User Defined Field of type String
udf_string_15	String	User Defined Field of type String
udf_string_16	String	User Defined Field of type String
udf_float_1	Float	User Defined Field of type Float
udf_float_2	Float	User Defined Field of type Float
udf_float_3	Float	User Defined Field of type Float
udf_float_4	Float	User Defined Field of type Float
udf_float_5	Float	User Defined Field of type Float
udf_float_6	Float	User Defined Field of type Float
udf_float_7	Float	User Defined Field of type Float
udf_float_8	Float	User Defined Field of type Float
udf_date_1	Date	User Defined Field of type Date
udf_date_2	Date	User Defined Field of type Date
udf_date_3	Date	User Defined Field of type Date
udf_date_4	Date	User Defined Field of type Date
udf_date_5	Date	User Defined Field of type Date
udf_date_6	Date	User Defined Field of type Date
udf_date_7	Date	User Defined Field of type Date
udf_date_8	Date	User Defined Field of type Date
kyc_profile	KYC profile object	The KYC profile information of the retrieved contact information Available from CRM.COM R14.0.0
demographics	Demographics object	The demographics of the retrieved contact information
company_profile	Company profile object	The company profile of the retrieved contact information
category	Category object	The category of the retrieved contact information
owned_by_group	Group object	The group that is owning the contact information Deprecated from CRM.COM R18.0.0 (replaced with owned_by_business_unit)
owned_by_business_unit	Business Unit Object	The business unit that is owning the contact information Available from CRM.COM R18.0.0
privacy_level	Privacy level object	The contact information's privacy level
log_information	Log Information Object	The log information related with the retrieved accounts receivable
addresses_set	Set of Contact information address Object	The addresses of the retrieved contact information
phones_set	Set of Contact information phone Object	The phones of the retrieved contact information
emails_set	Set of Contact information email Object	The emails of the retrieved contact information
relation_set	Set of Contact Information business and personal relation Objects	The business and personal relations of the retrieved contact information
authorization_settings	Contact Information Authorization settings object	The contact information's authorization settings information Available from CRM.COM R9.0.0
consent_information	Contact Consent Object	The contact information's consent information Available from CRM.COM R14.1.0

Referred Objects Response Data

kyc profile object response data

Name	Type	Description
kyc_profile_name	String	The KYC profile of the retrieved contact information
kyc_profile_expiration_date	Date	The KYC profile's expiration date
kyc_profile_state	String	The KYC profile's life cycle state. Available values are: PENDING_VERIFICATION, VERIFIED, REFUTE, EXPIRED

demographics object response data

Name	Type	Description
gender	String	The gender of the retrieved contact information which can be MALE or FEMALE
id_number	String	The ID number of the retrieved contact information
id_number_expiration_date	Date	The ID number's expiration date of the retrieved contact information Available from CRM.COM R14.0.0
passport_number	String	The passport number of the retrieved contact information
passport_number_expiration_date	Date	The passport's expiration date of the retrieved contact information Available from CRM.COM R14.0.0
social_security_number	String	The social security number of the retrieved contact information
date_of_birth	Date of Birth Object	The date of birth of the retrieved contact information
name_day	Name Day Object	The name day of the retrieved contact information
country_of_residence	Country Object	The country of residence of the retrieved contact information
id_issued_by_country	Country Object	The ID issued country of retrieved contact information
passport_issued_by_country	Country Object	The passport issued country of retrieved contact information
industry	Industry Object	The industry of retrieved contact information
industry_sector	Industry sector Object	The sector of retrieved contact information

Referred Objects Response Data

date_of_birth object response data

Name	Type	Description
day	Integer	The day of the retrieved date of birth
month	Integer	The month of the retrieved date of birth
year	Integer	The year of the retrieved date of birth

name_day object response data

Name	Type	Description
day	Integer	The day of the retrieved name day
month	Integer	The month of the retrieved name day

country object response data

Name	Type	Description
id	String	The id of the retrieved country
name	String	The name of the retrieved country
alternative_code	String	The alternative code of the retrieved country
dialing_code	String	The dialing code of the retrieved country Available from CRM.COM R15.1.0
two_character_code	String	The two character code of the retrieved country
three_character_code	String	The three character code of the retrieved country
country_flag	Image Object	The flag of the retrieved country Available from CRM.COM R15.1.0

Referred Objects Response Data

country_flag object response data

Name	Type	Description
id	String	The ID of the retrieved country flag
file	File Object	The information of the attached file

Referred Objects Response Data

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

industry object response data

Name	Type	Description
id	String	The id of the retrieved industry
name	String	The name of the retrieved industry
code	String	The code of the retrieved industry

industry sector object response data

Name	Type	Description
id	String	The id of the retrieved industry sector
name	String	The name of the retrieved industry sector
alternative_code	String	The alternative code of the retrieved industry sector

company profile object response data

Name	Type	Description
profile_year	Number	The profile year of the retrieved contact information
annual_turnover	Number	The annual turnover of the retrieved contact information
established_date	Date	The established date of the retrieved contact information
number_of_employees	Number	The number of employees of the retrieved contact information
registration_number	String	The registration number of the retrieved contact information
vat_registration_number	String	The vat registration number of the retrieved contact information
vat_registered_by	String	The vat registration by of the retrieved contact information
vat_registration_date	Date	The vat registration date of the retrieved contact information
tax_reference_number	String	The tax referenece number of the retrieved contact information
registered_in_country	Country Object	The country of residence of the retrieved contact information
industry	Industry Object	The industry of retrieved contact information
industry_sector	Industry sector Object	The sector of retrieved contact information

Referred Objects Response Data

country object response data

Name	Type	Description
id	String	The id of the retrieved country
name	String	The name of the retrieved country
alternative_code	String	The alternative code of the retrieved country
dialing_code	String	The dialing code of the retrieved country Available from CRM.COM R15.1.0
two_character_code	String	The two character code of the retrieved country
three_character_code	String	The three character code of the retrieved country
country_flag	Image Object	The flag of the retrieved country Available from CRM.COM R15.1.0

Referred Objects Response Data

country_flag object response data

Name	Type	Description
id	String	The ID of the retrieved country flag
file	File Object	The information of the attached file

Referred Objects Response Data

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

industry object response data

Name	Type	Description
id	String	The id of the retrieved industry
name	String	The name of the retrieved industry
code	String	The code of the retrieved industry

industry sector object response data

Name	Type	Description
id	String	The id of the retrieved industry sector
name	String	The name of the retrieved industry sector
alternative_code	String	The alternative code of the retrieved industry sector

contact category object response data

Name	Type	Description
id	String	The id of the retrieved category
name	String	The name of the retrieved category
code	String	The code of the retrieved category

group object response data

Name	Type	Description
id	String	The ID of the retrieved group
name	String	The name of the retrieved group
community_name	String	The name of the community that the retrieved group belongs to
alternative_code	String	The alternative code of the retrieved group
unified_code	String	The unified code of the retrieved group Available from CRM.COM R16.2.2
description	String	The description of the retrieved group

business unit object response data

Name	Type	Description
id	String	The ID of the retrieved business unit
name	String	The name of the retrieved business unit
code	String	The code of the retrieved business unit
unified_code	String	The unified code of the retrieved business unit
description	String	The description of the retrieved business unit
parent_business_unit_name	String	The name of the parent business unit that the retrieved business unit belongs to

privacy_level object response data

Name	Type	Description
id	String	The id of the retrieved privacy level
number	String	The number of the retrieved privacy level
name	String	The name of the retrieved privacy level
hierarchy_level	String	The hierarchy level of the retrieved privacy level

log_information object response data

Name	Type	Description
created_date	Date	The date that the retrieved record was created
updated_date	Date	The last date that the retrieved record was updated
created_by_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
created_by_business_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Available from CRM.COM R18.0.0
created_by_user	User Object	The user that created the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled
updated_by_unit	Unit Object	The last unit that updated the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
updated_by_business_unit	Unit Object	The last unit that updated the retrieved record Available from CRM.COM R18.0.0
updated_by_user	User Object	The last user that updated the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

Referred Objects Response Data

unit object response data

Name	Type	Description
id	String	The ID of the retrieved unit
name	String	The name of the retrieved unit
group_name	String	The name of the group that the retrieved unit belongs to
community_name	String	The name of the community that the retrieved unit belongs to
alternative_code	String	The alternative code of the retrieved unit
description	String	The description of the retrieved unit

business unit object response data

Name	Type	Description
id	String	The ID of the retrieved business unit
name	String	The name of the retrieved business unit
code	String	The code of the retrieved business unit
unified_code	String	The unified code of the retrieved business unit
description	String	The description of the retrieved business unit
parent_business_unit_name	String	The name of the parent business unit that the retrieved business unit belongs to

user object response data

Name	Type	Description
id	String	The ID of the retrieved user
username	String	The user name of the retrieved user
person_name	String	The full name of the retrieved user
email	String	The email of the retrieved user

address object response data

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

Name	Type	Description
id	String	The ID of the retrieved address
type	String	The type of the retrieved address which can be HOME, BUSINESS, POBOX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5
postal_code	String	The postal code of the retrieved address
street_name	String	The street name of the retrieved address
street_number	String	The street number of the retrieved address
floor	Integer	The floor of the retrieved address
apartment_number	String	The apartment number of the retrieved address
area	String	The area of the retrieved address
town_city	String	The town / city of the retrieved address
district	String	The district of the retrieved address
municipality	String	The municipality of the retrieved address
po_box	String	The PO box of the retrieved address
po_box_postal_code	String	The PO box postal code of the retrieved address
care_of	String	The care of person of the retrieved address
udf_string_1	String	User Defined Field of type String
udf_string_2	String	User Defined Field of type String
udf_string_3	String	User Defined Field of type String
udf_string_4	String	User Defined Field of type String
udf_string_5	String	User Defined Field of type String
udf_string_6	String	User Defined Field of type String
udf_string_7	String	User Defined Field of type String
udf_string_8	String	User Defined Field of type String
udf_string_9	String	User Defined Field of type String
udf_string_10	String	User Defined Field of type String
udf_string_11	String	User Defined Field of type String
udf_string_12	String	User Defined Field of type String
udf_string_13	String	User Defined Field of type String
udf_string_14	String	User Defined Field of type String
udf_string_15	String	User Defined Field of type String
udf_string_16	String	User Defined Field of type String
udf_float_1	Float	User Defined Field of type Float
udf_float_2	Float	User Defined Field of type Float
udf_float_3	Float	User Defined Field of type Float
udf_float_4	Float	User Defined Field of type Float
udf_date_1	Date	User Defined Field of type Date
udf_date_2	Date	User Defined Field of type Date
udf_date_3	Date	User Defined Field of type Date
udf_date_4	Date	User Defined Field of type Date
country	Country Object	The country of the retrieved address
is_primary	Boolean	Defines if the address is the contact's primary address or not. Available from CRM.COM R15

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

Name	Type	Description
id	String	The ID of the retrieved address
type	String	The type of the retrieved address which can be HOME, BUSINESS, POBOX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5
postal_code	String	The postal code of the retrieved address
town_city	String	The town / city of the retrieved address
address_line_1	String	The address line 1
address_line_2	String	The address line 2
state_province_county	String	The state or province or county of the address.
udf_string_1	String	User Defined Field of type String
udf_string_2	String	User Defined Field of type String
udf_string_3	String	User Defined Field of type String
udf_string_4	String	User Defined Field of type String
udf_string_5	String	User Defined Field of type String
udf_string_6	String	User Defined Field of type String
udf_string_7	String	User Defined Field of type String
udf_string_8	String	User Defined Field of type String
udf_string_9	String	User Defined Field of type String
udf_string_10	String	User Defined Field of type String
udf_string_11	String	User Defined Field of type String
udf_string_12	String	User Defined Field of type String
udf_string_13	String	User Defined Field of type String
udf_string_14	String	User Defined Field of type String
udf_string_15	String	User Defined Field of type String
udf_string_16	String	User Defined Field of type String
udf_float_1	Float	User Defined Field of type Float
udf_float_2	Float	User Defined Field of type Float
udf_float_3	Float	User Defined Field of type Float
udf_float_4	Float	User Defined Field of type Float
udf_date_1	Date	User Defined Field of type Date
udf_date_2	Date	User Defined Field of type Date
udf_date_3	Date	User Defined Field of type Date
udf_date_4	Date	User Defined Field of type Date
country	Country Object	The country of the retrieved address
is_primary	Boolean	Defines if the address is the contact's primary address or not. Available from CRM.COM R15

Referred Objects Response Data

country object response data

Name	Type	Description
id	String	The id of the retrieved country
name	String	The name of the retrieved country
alternative_code	String	The alternative code of the retrieved country
dialing_code	String	The dialing code of the retrieved country Available from CRM.COM R15.1.0
two_character_code	String	The two character code of the retrieved country
three_character_code	String	The three character code of the retrieved country
country_flag	Image Object	The flag of the retrieved country Available from CRM.COM R15.1.0

Referred Objects Response Data

country_flag object response data

Name	Type	Description
id	String	The ID of the retrieved country flag
file	File Object	The information of the attached file

Referred Objects Response Data

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

phone object response data

Name	Type	Description
id	String	The ID of the retrieved phone
type	String	The type of the retrieved phone which can be LANDLINE, MOBILE, FAX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5
number	String	The number of the retrieved phone
area_code	String	The area code of the retrieved phone
full_number	String	The full number of the retrieved phone
notes	String	The notes of the retrieved phone
udf_string_1	String	User Defined Field of type String
udf_string_2	String	User Defined Field of type String
udf_string_3	String	User Defined Field of type String
udf_string_4	String	User Defined Field of type String
udf_string_5	String	User Defined Field of type String
udf_string_6	String	User Defined Field of type String
udf_string_7	String	User Defined Field of type String
udf_string_8	String	User Defined Field of type String
udf_float_1	Float	User Defined Field of type Float
udf_float_2	Float	User Defined Field of type Float
udf_float_3	Float	User Defined Field of type Float
udf_float_4	Float	User Defined Field of type Float
udf_date_1	Date	User Defined Field of type Date
udf_date_2	Date	User Defined Field of type Date
udf_date_3	Date	User Defined Field of type Date
udf_date_4	Date	User Defined Field of type Date
country	Country Object	The country of the retrieved phone
is_primary	Boolean	Defines if the phone is the contact's primary phone or not. Available from CRM.COM R15

Referred Objects Response Data

country object response data

Name	Type	Description
id	String	The id of the retrieved country
name	String	The name of the retrieved country
alternative_code	String	The alternative code of the retrieved country
dialing_code	String	The dialing code of the retrieved country Available from CRM.COM R15.1.0
two_character_code	String	The two character code of the retrieved country
three_character_code	String	The three character code of the retrieved country
country_flag	Image Object	The flag of the retrieved country Available from CRM.COM R15.1.0

Referred Objects Response Data

country_flag object response data

Name	Type	Description
id	String	The ID of the retrieved country flag
file	File Object	The information of the attached file

Referred Objects Response Data

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

email object response data

Name	Type	Description
id	String	The ID of the retrieved email
type	String	The type of the retrieved email which can be PERSONAL, BUSINESS, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5
email_address	String	The address of the retrieved email
notes	String	The notes of the retrieved email
udf_string_1	String	User Defined Field of type String
udf_string_2	String	User Defined Field of type String
udf_string_3	String	User Defined Field of type String
udf_string_4	String	User Defined Field of type String
udf_string_5	String	User Defined Field of type String
udf_string_6	String	User Defined Field of type String
udf_string_7	String	User Defined Field of type String
udf_string_8	String	User Defined Field of type String
udf_float_1	Float	User Defined Field of type Float
udf_float_2	Float	User Defined Field of type Float
udf_float_3	Float	User Defined Field of type Float
udf_float_4	Float	User Defined Field of type Float
udf_date_1	Date	User Defined Field of type Date
udf_date_2	Date	User Defined Field of type Date
udf_date_3	Date	User Defined Field of type Date
udf_date_4	Date	User Defined Field of type Date
is_primary	Boolean	Defines if the email is the contact's primary email or not. Available from CRM.COM R15

contact_information_relation object response data

Name	Type	Description
id	String	The ID of the retrieved contact information business or personal relation
type	String	The type of the retrieved contact information business or personal relation which can be FAMILY MEMBER, EXTENDED FAMILY, PARTNER, CLOSE FRIEND, FRIEND, WORK COLLEAGUE, PARTNER COMPANY, CLIENT, EMPLOYER, EMPLOYEE, BUSINESS, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5
relation_type	String	The relation type of the retrieved contact information The supported values are INWARD, OUTWARD Available from CRM.COM R14.2.0 Deprecated from CRM.COM R17
notes	String	The notes of the retrieved contact information business or personal relation
contact_information	Contact Information Object	The related contact information

Referred Response Objects Data

contact_information object response data

Name	Type	Description
id	String	The ID of the retrieved contact information
type	String	The type of the retrieved contact information which can be PERSON or COMPANY
life_cycle_state	String	The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL
name	String	The full name of the retrieved contact information
first_name	String	The first name of the retrieved contact information
middle_name	String	The middle name of the retrieved contact information
last_name	String	The last name of the retrieved contact information
title	String	The title of the retrieved contact information
company_name	Sting	The company name of the retrieved contact information
demographics	Demographics Object	The demographics information of the retrieved contact information
company_profile	Company profile object	The company profile of the retrieve contact information

Referred Objects Response Data

demographics object response data

Name	Type	Description
gender	String	The gender of the retrieved contact information which can be MALE or FEMALE
id_number	String	The ID number of the retrieved contact information
id_number_expiration_date	Date	The ID number's expiration date of the retrieved contact information Available from CRM.COM R14.0.0
passport_number	String	The passport number of the retrieved contact information
passport_number_expiration_date	Date	The passport's expiration date of the retrieved contact information Available from CRM.COM R14.0.0
social_security_number	String	The social security number of the retrieved contact information
date_of_birth	Date of Birth Object	The date of birth of the retrieved contact information
name_day	Name Day Object	The name day of the retrieved contact information
country_of_residence	Country Object	The country of residence of the retrieved contact information
id_issued_by_country	Country Object	The ID issued country of retrieved contact information
passport_issued_by_country	Country Object	The passport issued country of retrieved contact information
industry	Industry Object	The industry of retrieved contact information
industry_sector	Industry sector Object	The sector of retrieved contact information

Referred Objects Response Data

date_of_birth object response data

Name	Type	Description
day	Integer	The day of the retrieved date of birth
month	Integer	The month of the retrieved date of birth
year	Integer	The year of the retrieved date of birth

name_day object response data

Name	Type	Description
day	Integer	The day of the retrieved name day
month	Integer	The month of the retrieved name day

country object response data

Name	Type	Description
id	String	The id of the retrieved country
name	String	The name of the retrieved country
alternative_code	String	The alternative code of the retrieved country
dialing_code	String	The dialing code of the retrieved country Available from CRM.COM R15.1.0
two_character_code	String	The two character code of the retrieved country
three_character_code	String	The three character code of the retrieved country
country_flag	Image Object	The flag of the retrieved country Available from CRM.COM R15.1.0

Referred Objects Response Data

country_flag object response data

Name	Type	Description
id	String	The ID of the retrieved country flag
file	File Object	The information of the attached file

Referred Objects Response Data

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

industry object response data

Name	Type	Description
id	String	The id of the retrieved industry
name	String	The name of the retrieved industry
code	String	The code of the retrieved industry

industry sector object response data

Name	Type	Description
id	String	The id of the retrieved industry sector
name	String	The name of the retrieved industry sector
alternative_code	String	The alternative code of the retrieved industry sector

company profile object response data

Name	Type	Description
profile_year	Number	The profile year of the retrieved contact information
annual_turnover	Number	The annual turnover of the retrieved contact information
established_date	Date	The established date of the retrieved contact information
number_of_employees	Number	The number of employees of the retrieved contact information
registration_number	String	The registration number of the retrieved contact information
vat_registration_number	String	The vat registration number of the retrieved contact information
vat_registered_by	String	The vat registration by of the retrieved contact information
vat_registration_date	Date	The vat registration date of the retrieved contact information
tax_reference_number	String	The tax referenece number of the retrieved contact information
registered_in_country	Country Object	The country of residence of the retrieved contact information
industry	Industry Object	The industry of retrieved contact information
industry_sector	Industry sector Object	The sector of retrieved contact information

Referred Objects Response Data

country object response data

Name	Type	Description
id	String	The id of the retrieved country
name	String	The name of the retrieved country
alternative_code	String	The alternative code of the retrieved country
dialing_code	String	The dialing code of the retrieved country Available from CRM.COM R15.1.0
two_character_code	String	The two character code of the retrieved country
three_character_code	String	The three character code of the retrieved country
country_flag	Image Object	The flag of the retrieved country Available from CRM.COM R15.1.0

Referred Objects Response Data

country_flag object response data

Name	Type	Description
id	String	The ID of the retrieved country flag
file	File Object	The information of the attached file

Referred Objects Response Data

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

industry object response data

Name	Type	Description
id	String	The id of the retrieved industry
name	String	The name of the retrieved industry
code	String	The code of the retrieved industry

industry sector object response data

Name	Type	Description
id	String	The id of the retrieved industry sector
name	String	The name of the retrieved industry sector
alternative_code	String	The alternative code of the retrieved industry sector

contact_information_authorization object response data

Name	Type	Description
send_direct_ marketing_material	Boolean	Defines whether the contact wants to be contacted for Direct Marketing purposes
direct_marketing_setting_updated_date	Date	The last date that the contact information's authorization setting for Direct Marketing was updated
send_affiliate_ marketing_material	Boolean	Defines whether the contact wants to be contacted for Affiliate Marketing purposes
affiliate_marketing_setting_updated_date	Date	The last date that the contact information's authorization setting for Affiliate Marketing was updated
direct_marketing_setting_updated_by_user	User Object	The name of the last user that updated the contact information's authorization setting for Affiliate Marketing
affiliated_marketing_setting_updated_by_user	User Object	The name of the last user that updated the contact information's authorization setting for Affiliate Marketing

Referred Objects Response Data

user object response data

Name	Type	Description
id	String	The ID of the retrieved user
username	String	The user name of the retrieved user
person_name	String	The full name of the retrieved user
email	String	The email of the retrieved user

contact consent object response data

Name	Type	Description
id	String	The ID of the retrieved contact information
contact_consent_state	String	The state of the Contact's Consent. Applicable values are: PENDING ACCEPTED REJECTED WITHDRAWN
contact_consent_updated_date	Date	The updated date of the Contact's Consent
contact_consent_form	Attachments Object	The Contact's accepted Consent Form. Applicable only if Consent State is ACCEPTED

Referred Objects Response Data

Attachments object response data

Name	Type	Description
id	String	The ID of the retrieved attachment
entity	String	The name of the entity related with the attachment. The supported entities are the following: ACCOUNTSRECEIVABLE ACTIVITIES COMMUNICATIONS COMMUNICATIONTEMPLATES CONTACTINFORMATION INSTALLEDITEMS JOBS LEADS PRODUCTS SERVICEREQUESTS ATTACHMENTSLIBRARY From CRM.COM R12.2.0, ATTACHMENTSLIBRARY is available From CRM.COM R14.0.0, COMMUNICATIONTEMPLATES is available
entity_id	String	The ID of the entity related with the attachment.
url	String	The attached URL. This information is empty if the attachment is a file.
notes	String	The comments related with the retrieved attachment
classification	Attachments Classification Object	The classification of the attachment Available from CRM.COM R12.2.0
file	File Object	The information of the attached file. This information is empty if the attachment is a URL.
log_information	Log Information Object	The log information of the retrieved attachment

Referred Objects Response Data

classification object response data

Name	Type	Description
id	String	The id of the retrieved attachment classification
name	String	The name of the retrieved attachment classification
alternative_code	String	The alternative code of the retrieved attachment classification

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

log_information object response data

Name	Type	Description
created_date	Date	The date that the retrieved record was created
updated_date	Date	The last date that the retrieved record was updated
created_by_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
created_by_business_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Available from CRM.COM R18.0.0
created_by_user	User Object	The user that created the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled
updated_by_unit	Unit Object	The last unit that updated the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
updated_by_business_unit	Unit Object	The last unit that updated the retrieved record Available from CRM.COM R18.0.0
updated_by_user	User Object	The last user that updated the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

Referred Objects Response Data

unit object response data

Name	Type	Description
id	String	The ID of the retrieved unit
name	String	The name of the retrieved unit
group_name	String	The name of the group that the retrieved unit belongs to
community_name	String	The name of the community that the retrieved unit belongs to
alternative_code	String	The alternative code of the retrieved unit
description	String	The description of the retrieved unit

business unit object response data

Name	Type	Description
id	String	The ID of the retrieved business unit
name	String	The name of the retrieved business unit
code	String	The code of the retrieved business unit
unified_code	String	The unified code of the retrieved business unit
description	String	The description of the retrieved business unit
parent_business_unit_name	String	The name of the parent business unit that the retrieved business unit belongs to

user object response data

Name	Type	Description
id	String	The ID of the retrieved user
username	String	The user name of the retrieved user
person_name	String	The full name of the retrieved user
email	String	The email of the retrieved user

Examples

Example 1

HTTP Method: GET

Request:

Response:

    {
       "status":
       {
           "message": null,
           "description": null,
           "code": "OK"
       },
       "data":
       {
           "udf_string_10": null,
           "organizational_unit": 0,
           "udf_float_1": 10,
           "udf_string_11": null,
           "udf_float_2": 20,
		   "preferred_language": "ENG",
           "udf_string_12": null,
           "udf_float_3": 30,
           "udf_string_13": null,
           "udf_float_4": 40,
           "udf_string_14": null,
           "udf_float_5": 50,
           "udf_string_15": null,
           "udf_string_1": "udf string 1",
           "name": "Louis Kozior",
           "udf_string_16": null,
           "udf_float_6": 60,
           "udf_string_2": "udf string 2",
           "udf_float_7": 70,
           "udf_string_3": "udf string 3",
           "privacy_level":
           {
               "number": "8",
               "hierarchy_level": 0,
               "name": "Regular Customers",
               "id": "EDE9CDE326E4F9846A50D5BCF61CD720"
           },
           "company_name": null,
           "udf_float_8": 80,
           "udf_string_4": "udf string 4",
           "udf_string_5": "udf string 5",
           "udf_string_6": "udf string 6",
           "udf_string_7": "udf string 7",
           "udf_string_8": "udf string 16",
           "udf_string_9": null,
           "last_name": "Kozior",
           "id": "1F1D2D0DFD164BFA801BE87CA9E33915",
           "relation_set":
           [
               {
                   "contact":
                   {
                       "last_name": "Kozior",
                       "life_cycle_state": "MARKETING",
                       "middle_name": "Aloz",
                       "company_profile": null,
                       "title": "Sir",
                       "type": "PERSON",
                       "first_name": "Louis",
                       "name": null,
                       "id": "1F1D2D0DFD164BFA801BE87CA9E33915",
                       "company_name": null,
                       "demographics":
                       {
                           "gender": "FEMALE",
                           "passport_number": "CD112234",
                           "social_security_number": "EF112234",
                           "date_of_birth":
                           {
                               "month": 5,
                               "day": 12,
                               "year": 1981
                           },
                           "name_day":
                           {
                               "month": 8,
                               "day": 18
                           },
                           "id_number": "AB112234"
                       }
                   },
                   "notes": null,
                   "type": "Family Member",
                   "id": "52062CE827B445DDA9100F2BDB04F06D"
               }
           ],
           "log_information":
           {
               "updated_date": "2015-04-28T16:51:51",
               "created_by_unit":
               {
                   "community_name": "Internal Community",
                   "group_name": "Main Group",
                   "name": "Admin Unit",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "description": "r1",
                   "alternative_code": "MG"
               },
               "created_date": "2015-04-28T16:51:50",
               "updated_by_unit":
               {
                   "community_name": "Internal Community",
                   "group_name": "Main Group",
                   "name": "Admin Unit",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "description": "r1",
                   "alternative_code": "MG"
               },
               "created_by_user":
               {
                   "person_name": "MPAdministrator",
                   "username": "MPAdministrator",
                   "id": "1",
                   "email": "mp@ministrator.com"
               },
               "updated_by_user":
               {
                   "person_name": "MPAdministrator",
                   "username": "MPAdministrator",
                   "id": "1",
                   "email": "mp@ministrator.com"
               }
           },
           "life_cycle_state": "MARKETING",
           "first_name": "Louis",
           "type": "PERSON",
           "notes": "Marios Lannister 28/4/2015 16:51:51 Family",
           "addresses_set":
           [
               {
                   "care_of": "Maria Kyriacou",
                   "street_number": "8",
                   "udf_string_10": null,
                   "udf_float_1": 10,
                   "udf_string_11": null,
                   "street_name": "Ilia Papakiriakou",
                   "udf_float_2": 20,
                   "udf_string_12": null,
                   "udf_float_3": 30,
                   "udf_string_13": null,
                   "udf_float_4": 40,
                   "udf_string_14": null,
                   "udf_string_15": null,
                   "po_box": "70022",
                   "udf_string_1": "udf string 1",
                   "udf_string_16": null,
                   "udf_string_2": "udf string 2",
                   "floor": 2,
                   "udf_string_3": "udf string 3",
                   "area": "Plati",
                   "udf_string_4": "udf string 4",
                   "district": "Nicosia",
                   "udf_string_5": "udf string 5",
                   "udf_string_6": "udf string 6",
                   "udf_string_7": "udf string 7",
                   "state": "Active",
                   "udf_string_8": "udf string 16",
                   "udf_string_9": null,
                   "country":
                   {
                       "three_character_code": "CYP",
                       "two_character_code": "CY",
                       "name": "CYPRUS",
                       "id": "181",
                       "alternative_code": null
                   },
                   "id": "A939A8F2FF7F4D37AEF3ED5A34A8238E",
                   "postal_code": "3020",
                   "udf_date_1": "2014-05-05T15:49:59",
                   "udf_date_2": "2014-06-05T15:49:59",
                   "udf_date_3": "2014-07-05T15:49:59",
                   "udf_date_4": "2014-08-05T15:49:59",
                   "po_box_postal_code": "AG70022",
                   "apartment_number": "202",
                   "town_city": "Aglanjia",
                   "type": "Home",
                   "municipality": "Aglanjia"
               }
           ],
           "title": "Sir",
           "company_profile":
           {
               "tax_reference_number": null,
               "annual_turnover": null,
               "number_of_employees": null,
               "profile_year": null,
               "established_date": null,
               "industry_sector":
               {
                   "name": "FOREX",
                   "id": "D8ACF18AB4494AD33738A9F4C94E6995",
                   "alternative_code": "FRX"
               },
               "registered_in_country": null,
               "vat_registration_number": null,
               "industry":
               {
                   "name": "Marketing",
                   "id": "31BC2070C79EAE5455BFAD41599C5190",
                   "code": "MK"
               },
               "vat_registration_date": null,
               "vat_registered_by": null,
               "registration_number": null
           },
           "udf_date_1": "2014-05-05T15:49:59",
           "phones_set":
           [
               {
                   "notes": null,
                   "udf_float_1": null,
                   "udf_float_2": null,
                   "udf_date_1": null,
                   "udf_float_3": null,
                   "udf_date_2": null,
                   "number": "22114455",
                   "udf_float_4": null,
                   "udf_date_3": null,
                   "udf_date_4": null,
                   "udf_string_1": null,
                   "udf_string_2": null,
                   "udf_string_3": null,
                   "udf_string_4": null,
                   "udf_string_5": null,
                   "udf_string_6": null,
                   "udf_string_7": null,
                   "state": "Active",
                   "udf_string_8": null,
                   "country":
                   {
                       "three_character_code": "USA",
                       "two_character_code": "US",
                       "name": "UNITED STATES",
                       "id": "127",
                       "alternative_code": null
                   },
                   "full_number": "00122114455",
                   "type": "Landline",
                   "id": "F593DEF1C332469B939E358A28773FB9",
                   "area_code": "1"
               }
           ],
           "udf_date_2": "2014-06-05T15:49:59",
           "udf_date_3": "2014-07-05T15:49:59",
           "udf_date_4": "2014-08-05T15:49:59",
           "udf_date_5": null,
           "udf_date_6": null,
           "demographics":
           {
               "gender": "FEMALE",
               "passport_issued_by_country":
               {
                   "three_character_code": "GRC",
                   "two_character_code": "GR",
                   "name": "GREECE",
                   "id": "209",
                   "alternative_code": null
               },
               "passport_number": "CD112234",
               "social_security_number": "EF112234",
               "country_of_residence":
               {
                   "three_character_code": "CYP",
                   "two_character_code": "CY",
                   "name": "CYPRUS",
                   "id": "181",
                   "alternative_code": null
               },
               "industry_sector":
               {
                   "name": "FOREX",
                   "id": "D8ACF18AB4494AD33738A9F4C94E6995",
                   "alternative_code": "FRX"
               },
               "date_of_birth":
               {
                   "month": 5,
                   "day": 12,
                   "year": 1981
               },
               "name_day":
               {
                   "month": 8,
                   "day": 18
               },
               "id_number": "AB112234",
               "id_issued_by_country":
               {
                   "three_character_code": "CYP",
                   "two_character_code": "CY",
                   "name": "CYPRUS",
                   "id": "181",
                   "alternative_code": null
               },
               "industry":
               {
                   "name": "Marketing",
                   "id": "31BC2070C79EAE5455BFAD41599C5190",
                   "code": "MK"
               }
           },
           "udf_date_7": null,
           "udf_date_8": null,
           "owned_by_group":
           {
               "community_name": "Internal Community",
               "name": "Main Group",
               "id": "84F33366CB592BAAE7E2044D93611C6A",
               "description": "Main Group",
               "alternative_code": "MG1"
           },
           "middle_name": "Aloz",
           "emails_set":
           [
               {
                   "notes": null,
                   "udf_float_1": null,
                   "udf_float_2": null,
                   "udf_date_1": null,
                   "udf_float_3": null,
                   "udf_date_2": null,
                   "udf_float_4": null,
                   "udf_date_3": null,
                   "udf_date_4": null,
                   "udf_string_1": null,
                   "udf_string_2": null,
                   "udf_string_3": null,
                   "udf_string_4": null,
                   "udf_string_5": null,
                   "udf_string_6": null,
                   "udf_string_7": null,
                   "state": "Active",
                   "udf_string_8": null,
                   "type": "Personal",
                   "id": "827AEC3875474B99B7829FCA52D2E4F8",
                   "email": "brianakozior@gmail.com"
               }
           ],
           "category":
           {
               "name": "Contact Category",
               "id": "486B0C17A39E5F5339BD16B288AE12FE",
               "code": "Contact Category"
           }
       }
    }

GET contact_information/list

This method returns information related with contact information. Multiple contact information can be returned by each call

Available from CRM.COM R5.0.0

Resource URL

Parameters

Name	Type	Description
token	String	The token retrieved from the login method
id_number (semi-optional)	String	The ID number of the contact information
passport_number (semi-optional)	String	The passport number of the contact information
social_security_number (semi-optional)	String	The social security number of the contact information
vat_registration_number (semi-optional)	String	The registration number of the contact information
fields_set (optional)	List of Strings, comma separated	A list of fields that should be included in the results. If not specified then all the available fields will be returned

Restrictions

It is mandatory to specify one of the semi-optional parameters. Multiple semi-optional parameters can be specified in each call

Response Data

Name	Type	Description
id	String	The ID of the retrieved contact information
type	String	The type of the retrieved contact information which can be PERSON or COMPANY
life_cycle_state	String	The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL
name	String	The full name of the retrieved contact information
title	String	The title of the retrieved contact information
first_name	String	The first name of the retrieved contact information
middle_name	String	The middle name of the retrieved contact information
last_name	String	The last name of the retrieved contact information
company_name	Sting	The company name of the retrieved contact information
notes	String	Notes for the contact information
organizational_unit	Integer	Indicates whether a contacts belongs to an organisational unit or not
preferred_language	String	The Contact Information's preferred language. The available values are: ARA DAN ENG EST FIN FRA DEU ELL JPN VIE MAL IND TAI LAV LIT NNO POL POR RUS SPA SWE UKR CMN TGL HIN CUSTOM1 CUSTOM2 CUSTOM3 CUSTOM4 CUSTOM5 CUSTOM6 CUSTOM7 CUSTOM8 Available from CRM.COM R12.0.0
udf_string_1	String	User Defined Field of type String
udf_string_2	String	User Defined Field of type String
udf_string_3	String	User Defined Field of type String
udf_string_4	String	User Defined Field of type String
udf_string_5	String	User Defined Field of type String
udf_string_6	String	User Defined Field of type String
udf_string_7	String	User Defined Field of type String
udf_string_8	String	User Defined Field of type String
udf_string_9	String	User Defined Field of type String
udf_string_10	String	User Defined Field of type String
udf_string_11	String	User Defined Field of type String
udf_string_12	String	User Defined Field of type String
udf_string_13	String	User Defined Field of type String
udf_string_14	String	User Defined Field of type String
udf_string_15	String	User Defined Field of type String
udf_string_16	String	User Defined Field of type String
udf_float_1	Float	User Defined Field of type Float
udf_float_2	Float	User Defined Field of type Float
udf_float_3	Float	User Defined Field of type Float
udf_float_4	Float	User Defined Field of type Float
udf_float_5	Float	User Defined Field of type Float
udf_float_6	Float	User Defined Field of type Float
udf_float_7	Float	User Defined Field of type Float
udf_float_8	Float	User Defined Field of type Float
udf_date_1	Date	User Defined Field of type Date
udf_date_2	Date	User Defined Field of type Date
udf_date_3	Date	User Defined Field of type Date
udf_date_4	Date	User Defined Field of type Date
udf_date_5	Date	User Defined Field of type Date
udf_date_6	Date	User Defined Field of type Date
udf_date_7	Date	User Defined Field of type Date
udf_date_8	Date	User Defined Field of type Date
kyc_profile	KYC profile object	The KYC profile information of the retrieved contact information Available from CRM.COM R14.0.0
demographics	Demographics object	The demographics of the retrieved contact information
company_profile	Company profile object	The company profile of the retrieved contact information
category	Category object	The category of the retrieved contact information
owned_by_group	Group object	The group that is owning the contact information Deprecated from CRM.COM R18.0.0 (replaced with owned_by_business_unit)
owned_by_business_unit	Business Unit Object	The business unit that is owning the contact information Available from CRM.COM R18.0.0
privacy_level	Privacy level object	The contact information's privacy level
log_information	Log Information Object	The log information related with the retrieved accounts receivable
addresses_set	Set of Contact information address Object	The addresses of the retrieved contact information
phones_set	Set of Contact information phone Object	The phones of the retrieved contact information
emails_set	Set of Contact information email Object	The emails of the retrieved contact information
relation_set	Set of Contact Information business and personal relation Objects	The business and personal relations of the retrieved contact information
authorization_settings	Contact Information Authorization settings object	The contact information's authorization settings information Available from CRM.COM R9.0.0
consent_information	Contact Consent Object	The contact information's consent information Available from CRM.COM R14.1.0

Referred Objects Response Data

kyc profile object response data

Name	Type	Description
kyc_profile_name	String	The KYC profile of the retrieved contact information
kyc_profile_expiration_date	Date	The KYC profile's expiration date
kyc_profile_state	String	The KYC profile's life cycle state. Available values are: PENDING_VERIFICATION, VERIFIED, REFUTE, EXPIRED

demographics object response data

Name	Type	Description
gender	String	The gender of the retrieved contact information which can be MALE or FEMALE
id_number	String	The ID number of the retrieved contact information
id_number_expiration_date	Date	The ID number's expiration date of the retrieved contact information Available from CRM.COM R14.0.0
passport_number	String	The passport number of the retrieved contact information
passport_number_expiration_date	Date	The passport's expiration date of the retrieved contact information Available from CRM.COM R14.0.0
social_security_number	String	The social security number of the retrieved contact information
date_of_birth	Date of Birth Object	The date of birth of the retrieved contact information
name_day	Name Day Object	The name day of the retrieved contact information
country_of_residence	Country Object	The country of residence of the retrieved contact information
id_issued_by_country	Country Object	The ID issued country of retrieved contact information
passport_issued_by_country	Country Object	The passport issued country of retrieved contact information
industry	Industry Object	The industry of retrieved contact information
industry_sector	Industry sector Object	The sector of retrieved contact information

Referred Objects Response Data

date_of_birth object response data

Name	Type	Description
day	Integer	The day of the retrieved date of birth
month	Integer	The month of the retrieved date of birth
year	Integer	The year of the retrieved date of birth

name_day object response data

Name	Type	Description
day	Integer	The day of the retrieved name day
month	Integer	The month of the retrieved name day

country object response data

Name	Type	Description
id	String	The id of the retrieved country
name	String	The name of the retrieved country
alternative_code	String	The alternative code of the retrieved country
dialing_code	String	The dialing code of the retrieved country Available from CRM.COM R15.1.0
two_character_code	String	The two character code of the retrieved country
three_character_code	String	The three character code of the retrieved country
country_flag	Image Object	The flag of the retrieved country Available from CRM.COM R15.1.0

Referred Objects Response Data

country_flag object response data

Name	Type	Description
id	String	The ID of the retrieved country flag
file	File Object	The information of the attached file

Referred Objects Response Data

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

industry object response data

Name	Type	Description
id	String	The id of the retrieved industry
name	String	The name of the retrieved industry
code	String	The code of the retrieved industry

industry sector object response data

Name	Type	Description
id	String	The id of the retrieved industry sector
name	String	The name of the retrieved industry sector
alternative_code	String	The alternative code of the retrieved industry sector

company profile object response data

Name	Type	Description
profile_year	Number	The profile year of the retrieved contact information
annual_turnover	Number	The annual turnover of the retrieved contact information
established_date	Date	The established date of the retrieved contact information
number_of_employees	Number	The number of employees of the retrieved contact information
registration_number	String	The registration number of the retrieved contact information
vat_registration_number	String	The vat registration number of the retrieved contact information
vat_registered_by	String	The vat registration by of the retrieved contact information
vat_registration_date	Date	The vat registration date of the retrieved contact information
tax_reference_number	String	The tax referenece number of the retrieved contact information
registered_in_country	Country Object	The country of residence of the retrieved contact information
industry	Industry Object	The industry of retrieved contact information
industry_sector	Industry sector Object	The sector of retrieved contact information

Referred Objects Response Data

country object response data

Name	Type	Description
id	String	The id of the retrieved country
name	String	The name of the retrieved country
alternative_code	String	The alternative code of the retrieved country
dialing_code	String	The dialing code of the retrieved country Available from CRM.COM R15.1.0
two_character_code	String	The two character code of the retrieved country
three_character_code	String	The three character code of the retrieved country
country_flag	Image Object	The flag of the retrieved country Available from CRM.COM R15.1.0

Referred Objects Response Data

country_flag object response data

Name	Type	Description
id	String	The ID of the retrieved country flag
file	File Object	The information of the attached file

Referred Objects Response Data

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

industry object response data

Name	Type	Description
id	String	The id of the retrieved industry
name	String	The name of the retrieved industry
code	String	The code of the retrieved industry

industry sector object response data

Name	Type	Description
id	String	The id of the retrieved industry sector
name	String	The name of the retrieved industry sector
alternative_code	String	The alternative code of the retrieved industry sector

contact category object response data

Name	Type	Description
id	String	The id of the retrieved category
name	String	The name of the retrieved category
code	String	The code of the retrieved category

group object response data

Name	Type	Description
id	String	The ID of the retrieved group
name	String	The name of the retrieved group
community_name	String	The name of the community that the retrieved group belongs to
alternative_code	String	The alternative code of the retrieved group
unified_code	String	The unified code of the retrieved group Available from CRM.COM R16.2.2
description	String	The description of the retrieved group

business unit object response data

Name	Type	Description
id	String	The ID of the retrieved business unit
name	String	The name of the retrieved business unit
code	String	The code of the retrieved business unit
unified_code	String	The unified code of the retrieved business unit
description	String	The description of the retrieved business unit
parent_business_unit_name	String	The name of the parent business unit that the retrieved business unit belongs to

privacy_level object response data

Name	Type	Description
id	String	The id of the retrieved privacy level
number	String	The number of the retrieved privacy level
name	String	The name of the retrieved privacy level
hierarchy_level	String	The hierarchy level of the retrieved privacy level

log_information object response data

Name	Type	Description
created_date	Date	The date that the retrieved record was created
updated_date	Date	The last date that the retrieved record was updated
created_by_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
created_by_business_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Available from CRM.COM R18.0.0
created_by_user	User Object	The user that created the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled
updated_by_unit	Unit Object	The last unit that updated the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
updated_by_business_unit	Unit Object	The last unit that updated the retrieved record Available from CRM.COM R18.0.0
updated_by_user	User Object	The last user that updated the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

Referred Objects Response Data

unit object response data

Name	Type	Description
id	String	The ID of the retrieved unit
name	String	The name of the retrieved unit
group_name	String	The name of the group that the retrieved unit belongs to
community_name	String	The name of the community that the retrieved unit belongs to
alternative_code	String	The alternative code of the retrieved unit
description	String	The description of the retrieved unit

business unit object response data

Name	Type	Description
id	String	The ID of the retrieved business unit
name	String	The name of the retrieved business unit
code	String	The code of the retrieved business unit
unified_code	String	The unified code of the retrieved business unit
description	String	The description of the retrieved business unit
parent_business_unit_name	String	The name of the parent business unit that the retrieved business unit belongs to

user object response data

Name	Type	Description
id	String	The ID of the retrieved user
username	String	The user name of the retrieved user
person_name	String	The full name of the retrieved user
email	String	The email of the retrieved user

address object response data

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

Name	Type	Description
id	String	The ID of the retrieved address
type	String	The type of the retrieved address which can be HOME, BUSINESS, POBOX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5
postal_code	String	The postal code of the retrieved address
street_name	String	The street name of the retrieved address
street_number	String	The street number of the retrieved address
floor	Integer	The floor of the retrieved address
apartment_number	String	The apartment number of the retrieved address
area	String	The area of the retrieved address
town_city	String	The town / city of the retrieved address
district	String	The district of the retrieved address
municipality	String	The municipality of the retrieved address
po_box	String	The PO box of the retrieved address
po_box_postal_code	String	The PO box postal code of the retrieved address
care_of	String	The care of person of the retrieved address
udf_string_1	String	User Defined Field of type String
udf_string_2	String	User Defined Field of type String
udf_string_3	String	User Defined Field of type String
udf_string_4	String	User Defined Field of type String
udf_string_5	String	User Defined Field of type String
udf_string_6	String	User Defined Field of type String
udf_string_7	String	User Defined Field of type String
udf_string_8	String	User Defined Field of type String
udf_string_9	String	User Defined Field of type String
udf_string_10	String	User Defined Field of type String
udf_string_11	String	User Defined Field of type String
udf_string_12	String	User Defined Field of type String
udf_string_13	String	User Defined Field of type String
udf_string_14	String	User Defined Field of type String
udf_string_15	String	User Defined Field of type String
udf_string_16	String	User Defined Field of type String
udf_float_1	Float	User Defined Field of type Float
udf_float_2	Float	User Defined Field of type Float
udf_float_3	Float	User Defined Field of type Float
udf_float_4	Float	User Defined Field of type Float
udf_date_1	Date	User Defined Field of type Date
udf_date_2	Date	User Defined Field of type Date
udf_date_3	Date	User Defined Field of type Date
udf_date_4	Date	User Defined Field of type Date
country	Country Object	The country of the retrieved address
is_primary	Boolean	Defines if the address is the contact's primary address or not. Available from CRM.COM R15

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

Name	Type	Description
id	String	The ID of the retrieved address
type	String	The type of the retrieved address which can be HOME, BUSINESS, POBOX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5
postal_code	String	The postal code of the retrieved address
town_city	String	The town / city of the retrieved address
address_line_1	String	The address line 1
address_line_2	String	The address line 2
state_province_county	String	The state or province or county of the address.
udf_string_1	String	User Defined Field of type String
udf_string_2	String	User Defined Field of type String
udf_string_3	String	User Defined Field of type String
udf_string_4	String	User Defined Field of type String
udf_string_5	String	User Defined Field of type String
udf_string_6	String	User Defined Field of type String
udf_string_7	String	User Defined Field of type String
udf_string_8	String	User Defined Field of type String
udf_string_9	String	User Defined Field of type String
udf_string_10	String	User Defined Field of type String
udf_string_11	String	User Defined Field of type String
udf_string_12	String	User Defined Field of type String
udf_string_13	String	User Defined Field of type String
udf_string_14	String	User Defined Field of type String
udf_string_15	String	User Defined Field of type String
udf_string_16	String	User Defined Field of type String
udf_float_1	Float	User Defined Field of type Float
udf_float_2	Float	User Defined Field of type Float
udf_float_3	Float	User Defined Field of type Float
udf_float_4	Float	User Defined Field of type Float
udf_date_1	Date	User Defined Field of type Date
udf_date_2	Date	User Defined Field of type Date
udf_date_3	Date	User Defined Field of type Date
udf_date_4	Date	User Defined Field of type Date
country	Country Object	The country of the retrieved address
is_primary	Boolean	Defines if the address is the contact's primary address or not. Available from CRM.COM R15

Referred Objects Response Data

country object response data

Name	Type	Description
id	String	The id of the retrieved country
name	String	The name of the retrieved country
alternative_code	String	The alternative code of the retrieved country
dialing_code	String	The dialing code of the retrieved country Available from CRM.COM R15.1.0
two_character_code	String	The two character code of the retrieved country
three_character_code	String	The three character code of the retrieved country
country_flag	Image Object	The flag of the retrieved country Available from CRM.COM R15.1.0

Referred Objects Response Data

country_flag object response data

Name	Type	Description
id	String	The ID of the retrieved country flag
file	File Object	The information of the attached file

Referred Objects Response Data

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

phone object response data

Name	Type	Description
id	String	The ID of the retrieved phone
type	String	The type of the retrieved phone which can be LANDLINE, MOBILE, FAX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5
number	String	The number of the retrieved phone
area_code	String	The area code of the retrieved phone
full_number	String	The full number of the retrieved phone
notes	String	The notes of the retrieved phone
udf_string_1	String	User Defined Field of type String
udf_string_2	String	User Defined Field of type String
udf_string_3	String	User Defined Field of type String
udf_string_4	String	User Defined Field of type String
udf_string_5	String	User Defined Field of type String
udf_string_6	String	User Defined Field of type String
udf_string_7	String	User Defined Field of type String
udf_string_8	String	User Defined Field of type String
udf_float_1	Float	User Defined Field of type Float
udf_float_2	Float	User Defined Field of type Float
udf_float_3	Float	User Defined Field of type Float
udf_float_4	Float	User Defined Field of type Float
udf_date_1	Date	User Defined Field of type Date
udf_date_2	Date	User Defined Field of type Date
udf_date_3	Date	User Defined Field of type Date
udf_date_4	Date	User Defined Field of type Date
country	Country Object	The country of the retrieved phone
is_primary	Boolean	Defines if the phone is the contact's primary phone or not. Available from CRM.COM R15

Referred Objects Response Data

country object response data

Name	Type	Description
id	String	The id of the retrieved country
name	String	The name of the retrieved country
alternative_code	String	The alternative code of the retrieved country
dialing_code	String	The dialing code of the retrieved country Available from CRM.COM R15.1.0
two_character_code	String	The two character code of the retrieved country
three_character_code	String	The three character code of the retrieved country
country_flag	Image Object	The flag of the retrieved country Available from CRM.COM R15.1.0

Referred Objects Response Data

country_flag object response data

Name	Type	Description
id	String	The ID of the retrieved country flag
file	File Object	The information of the attached file

Referred Objects Response Data

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

email object response data

Name	Type	Description
id	String	The ID of the retrieved email
type	String	The type of the retrieved email which can be PERSONAL, BUSINESS, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5
email_address	String	The address of the retrieved email
notes	String	The notes of the retrieved email
udf_string_1	String	User Defined Field of type String
udf_string_2	String	User Defined Field of type String
udf_string_3	String	User Defined Field of type String
udf_string_4	String	User Defined Field of type String
udf_string_5	String	User Defined Field of type String
udf_string_6	String	User Defined Field of type String
udf_string_7	String	User Defined Field of type String
udf_string_8	String	User Defined Field of type String
udf_float_1	Float	User Defined Field of type Float
udf_float_2	Float	User Defined Field of type Float
udf_float_3	Float	User Defined Field of type Float
udf_float_4	Float	User Defined Field of type Float
udf_date_1	Date	User Defined Field of type Date
udf_date_2	Date	User Defined Field of type Date
udf_date_3	Date	User Defined Field of type Date
udf_date_4	Date	User Defined Field of type Date
is_primary	Boolean	Defines if the email is the contact's primary email or not. Available from CRM.COM R15

contact_information_relation object response data

Name	Type	Description
id	String	The ID of the retrieved contact information business or personal relation
type	String	The type of the retrieved contact information business or personal relation which can be FAMILY MEMBER, EXTENDED FAMILY, PARTNER, CLOSE FRIEND, FRIEND, WORK COLLEAGUE, PARTNER COMPANY, CLIENT, EMPLOYER, EMPLOYEE, BUSINESS, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5
relation_type	String	The relation type of the retrieved contact information The supported values are INWARD, OUTWARD Available from CRM.COM R14.2.0 Deprecated from CRM.COM R17
notes	String	The notes of the retrieved contact information business or personal relation
contact_information	Contact Information Object	The related contact information

Referred Response Objects Data

contact_information object response data

Name	Type	Description
id	String	The ID of the retrieved contact information
type	String	The type of the retrieved contact information which can be PERSON or COMPANY
life_cycle_state	String	The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL
name	String	The full name of the retrieved contact information
first_name	String	The first name of the retrieved contact information
middle_name	String	The middle name of the retrieved contact information
last_name	String	The last name of the retrieved contact information
title	String	The title of the retrieved contact information
company_name	Sting	The company name of the retrieved contact information
demographics	Demographics Object	The demographics information of the retrieved contact information
company_profile	Company profile object	The company profile of the retrieve contact information

Referred Objects Response Data

demographics object response data

Name	Type	Description
gender	String	The gender of the retrieved contact information which can be MALE or FEMALE
id_number	String	The ID number of the retrieved contact information
id_number_expiration_date	Date	The ID number's expiration date of the retrieved contact information Available from CRM.COM R14.0.0
passport_number	String	The passport number of the retrieved contact information
passport_number_expiration_date	Date	The passport's expiration date of the retrieved contact information Available from CRM.COM R14.0.0
social_security_number	String	The social security number of the retrieved contact information
date_of_birth	Date of Birth Object	The date of birth of the retrieved contact information
name_day	Name Day Object	The name day of the retrieved contact information
country_of_residence	Country Object	The country of residence of the retrieved contact information
id_issued_by_country	Country Object	The ID issued country of retrieved contact information
passport_issued_by_country	Country Object	The passport issued country of retrieved contact information
industry	Industry Object	The industry of retrieved contact information
industry_sector	Industry sector Object	The sector of retrieved contact information

Referred Objects Response Data

date_of_birth object response data

Name	Type	Description
day	Integer	The day of the retrieved date of birth
month	Integer	The month of the retrieved date of birth
year	Integer	The year of the retrieved date of birth

name_day object response data

Name	Type	Description
day	Integer	The day of the retrieved name day
month	Integer	The month of the retrieved name day

country object response data

Name	Type	Description
id	String	The id of the retrieved country
name	String	The name of the retrieved country
alternative_code	String	The alternative code of the retrieved country
dialing_code	String	The dialing code of the retrieved country Available from CRM.COM R15.1.0
two_character_code	String	The two character code of the retrieved country
three_character_code	String	The three character code of the retrieved country
country_flag	Image Object	The flag of the retrieved country Available from CRM.COM R15.1.0

Referred Objects Response Data

country_flag object response data

Name	Type	Description
id	String	The ID of the retrieved country flag
file	File Object	The information of the attached file

Referred Objects Response Data

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

industry object response data

Name	Type	Description
id	String	The id of the retrieved industry
name	String	The name of the retrieved industry
code	String	The code of the retrieved industry

industry sector object response data

Name	Type	Description
id	String	The id of the retrieved industry sector
name	String	The name of the retrieved industry sector
alternative_code	String	The alternative code of the retrieved industry sector

company profile object response data

Name	Type	Description
profile_year	Number	The profile year of the retrieved contact information
annual_turnover	Number	The annual turnover of the retrieved contact information
established_date	Date	The established date of the retrieved contact information
number_of_employees	Number	The number of employees of the retrieved contact information
registration_number	String	The registration number of the retrieved contact information
vat_registration_number	String	The vat registration number of the retrieved contact information
vat_registered_by	String	The vat registration by of the retrieved contact information
vat_registration_date	Date	The vat registration date of the retrieved contact information
tax_reference_number	String	The tax referenece number of the retrieved contact information
registered_in_country	Country Object	The country of residence of the retrieved contact information
industry	Industry Object	The industry of retrieved contact information
industry_sector	Industry sector Object	The sector of retrieved contact information

Referred Objects Response Data

country object response data

Name	Type	Description
id	String	The id of the retrieved country
name	String	The name of the retrieved country
alternative_code	String	The alternative code of the retrieved country
dialing_code	String	The dialing code of the retrieved country Available from CRM.COM R15.1.0
two_character_code	String	The two character code of the retrieved country
three_character_code	String	The three character code of the retrieved country
country_flag	Image Object	The flag of the retrieved country Available from CRM.COM R15.1.0

Referred Objects Response Data

country_flag object response data

Name	Type	Description
id	String	The ID of the retrieved country flag
file	File Object	The information of the attached file

Referred Objects Response Data

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

industry object response data

Name	Type	Description
id	String	The id of the retrieved industry
name	String	The name of the retrieved industry
code	String	The code of the retrieved industry

industry sector object response data

Name	Type	Description
id	String	The id of the retrieved industry sector
name	String	The name of the retrieved industry sector
alternative_code	String	The alternative code of the retrieved industry sector

contact_information_authorization object response data

Name	Type	Description
send_direct_ marketing_material	Boolean	Defines whether the contact wants to be contacted for Direct Marketing purposes
direct_marketing_setting_updated_date	Date	The last date that the contact information's authorization setting for Direct Marketing was updated
send_affiliate_ marketing_material	Boolean	Defines whether the contact wants to be contacted for Affiliate Marketing purposes
affiliate_marketing_setting_updated_date	Date	The last date that the contact information's authorization setting for Affiliate Marketing was updated
direct_marketing_setting_updated_by_user	User Object	The name of the last user that updated the contact information's authorization setting for Affiliate Marketing
affiliated_marketing_setting_updated_by_user	User Object	The name of the last user that updated the contact information's authorization setting for Affiliate Marketing

Referred Objects Response Data

user object response data

Name	Type	Description
id	String	The ID of the retrieved user
username	String	The user name of the retrieved user
person_name	String	The full name of the retrieved user
email	String	The email of the retrieved user

contact consent object response data

Name	Type	Description
id	String	The ID of the retrieved contact information
contact_consent_state	String	The state of the Contact's Consent. Applicable values are: PENDING ACCEPTED REJECTED WITHDRAWN
contact_consent_updated_date	Date	The updated date of the Contact's Consent
contact_consent_form	Attachments Object	The Contact's accepted Consent Form. Applicable only if Consent State is ACCEPTED

Referred Objects Response Data

Attachments object response data

Name	Type	Description
id	String	The ID of the retrieved attachment
entity	String	The name of the entity related with the attachment. The supported entities are the following: ACCOUNTSRECEIVABLE ACTIVITIES COMMUNICATIONS COMMUNICATIONTEMPLATES CONTACTINFORMATION INSTALLEDITEMS JOBS LEADS PRODUCTS SERVICEREQUESTS ATTACHMENTSLIBRARY From CRM.COM R12.2.0, ATTACHMENTSLIBRARY is available From CRM.COM R14.0.0, COMMUNICATIONTEMPLATES is available
entity_id	String	The ID of the entity related with the attachment.
url	String	The attached URL. This information is empty if the attachment is a file.
notes	String	The comments related with the retrieved attachment
classification	Attachments Classification Object	The classification of the attachment Available from CRM.COM R12.2.0
file	File Object	The information of the attached file. This information is empty if the attachment is a URL.
log_information	Log Information Object	The log information of the retrieved attachment

Referred Objects Response Data

classification object response data

Name	Type	Description
id	String	The id of the retrieved attachment classification
name	String	The name of the retrieved attachment classification
alternative_code	String	The alternative code of the retrieved attachment classification

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

log_information object response data

Name	Type	Description
created_date	Date	The date that the retrieved record was created
updated_date	Date	The last date that the retrieved record was updated
created_by_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
created_by_business_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Available from CRM.COM R18.0.0
created_by_user	User Object	The user that created the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled
updated_by_unit	Unit Object	The last unit that updated the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
updated_by_business_unit	Unit Object	The last unit that updated the retrieved record Available from CRM.COM R18.0.0
updated_by_user	User Object	The last user that updated the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

Referred Objects Response Data

unit object response data

Name	Type	Description
id	String	The ID of the retrieved unit
name	String	The name of the retrieved unit
group_name	String	The name of the group that the retrieved unit belongs to
community_name	String	The name of the community that the retrieved unit belongs to
alternative_code	String	The alternative code of the retrieved unit
description	String	The description of the retrieved unit

business unit object response data

Name	Type	Description
id	String	The ID of the retrieved business unit
name	String	The name of the retrieved business unit
code	String	The code of the retrieved business unit
unified_code	String	The unified code of the retrieved business unit
description	String	The description of the retrieved business unit
parent_business_unit_name	String	The name of the parent business unit that the retrieved business unit belongs to

user object response data

Name	Type	Description
id	String	The ID of the retrieved user
username	String	The user name of the retrieved user
person_name	String	The full name of the retrieved user
email	String	The email of the retrieved user

Examples

Example 1

HTTP Method: GET

Request:

Response:

    {
       "status":
       {
           "message": null,
           "description": null,
           "code": "OK"
       },
       "data":
       [
           {
               "udf_string_10": "userfield10",
               "organizational_unit": 0,
               "udf_float_1": 10,
               "udf_string_11": "userfield11",
               "udf_float_2": 12,
               "udf_string_12": "userfield12",
               "udf_float_3": 13,
               "udf_string_13": "userfield13",
               "udf_float_4": 14,
               "udf_string_14": "userfield14",
               "udf_float_5": 5,
               "udf_string_15": "userfield15",
               "udf_string_1": "userfield1",
               "name": "Maria Ioannou",
               "udf_string_16": "userfield16",
               "udf_float_6": 2,
               "udf_string_2": "userfield2",
               "udf_float_7": 1,
               "udf_string_3": "userfield3",
               "privacy_level":
               {
                   "number": null,
                   "hierarchy_level": 3,
                   "name": "Moderate",
                   "id": "9450216690684C416363B57DAD4596C3"
               },
               "company_name": null,
               "udf_float_8": 7,
               "udf_string_4": "userfield4",
               "udf_string_5": "userfield5",
               "udf_string_6": "userfield6",
               "udf_string_7": "userfield7",
               "udf_string_8": "userfield8",
               "udf_string_9": "userfield9",
               "last_name": "Ioannou",
               "id": "0514658236551391DE14490617FA49CA",
               "relation_set":
               [
               ],
               "log_information":
               {
                   "updated_date": "2014-10-24T09:17:07",
                   "created_by_unit":
                   {
                       "community_name": "Main Community",
                       "group_name": "Main Group",
                       "name": "Admin Unit",
                       "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                       "description": "r1",
                       "alternative_code": "MG"
                   },
                   "created_date": "2013-10-11T17:30:16",
                   "updated_by_unit":
                   {
                       "community_name": "Main Community",
                       "group_name": "Main Group",
                       "name": "Admin Unit",
                       "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                       "description": "r1",
                       "alternative_code": "MG"
                   },
                   "created_by_user":
                   {
                       "person_name": "MPAdministrator",
                       "username": "MPAdministrator",
                       "id": "1",
                       "email": "mp@ministrator.com"
                   },
                   "updated_by_user":
                   {
                       "person_name": "MPAdministrator",
                       "username": "MPAdministrator",
                       "id": "1",
                       "email": "mp@ministrator.com"
                   }
               },
               "life_cycle_state": "FINANCIAL",
               "first_name": "Maria",
               "type": "PERSON",
               "addresses_set":
               [
                   {
                       "care_of": "MML",
                       "street_number": "12",
                       "udf_string_10": null,
                       "udf_float_1": null,
                       "udf_string_11": null,
                       "street_name": "ilia papakiriakou",
                       "udf_float_2": null,
                       "udf_string_12": null,
                       "udf_float_3": null,
                       "udf_string_13": null,
                       "udf_float_4": null,
                       "udf_string_14": null,
                       "udf_string_15": null,
                       "po_box": "1212",
                       "udf_string_1": null,
                       "udf_string_16": null,
                       "udf_string_2": null,
                       "floor": 9,
                       "udf_string_3": null,
                       "area": "Makedonitisa",
                       "udf_string_4": null,
                       "district": "Nicosia",
                       "udf_string_5": null,
                       "udf_string_6": null,
                       "udf_string_7": null,
                       "state": "Inactive",
                       "udf_string_8": null,
                       "udf_string_9": null,
                       "country":
                       {
                           "name": "CYPRUS",
                           "id": "181"
                       },
                       "id": "2E7D50026366AF98CD006C5883E825DA",
                       "postal_code": "pc0001",
                       "udf_date_1": null,
                       "udf_date_2": null,
                       "udf_date_3": null,
                       "udf_date_4": null,
                       "po_box_postal_code": "1323",
                       "apartment_number": "91",
                       "town_city": "Lefkosia",
                       "type": "Home",
                       "municipality": "Nicosia"
                   },
                   {
                       "care_of": "MML",
                       "street_number": "23",
                       "udf_string_10": null,
                       "udf_float_1": null,
                       "udf_string_11": null,
                       "street_name": "Egnatias 102",
                       "udf_float_2": null,
                       "udf_string_12": null,
                       "udf_float_3": null,
                       "udf_string_13": null,
                       "udf_float_4": null,
                       "udf_string_14": null,
                       "udf_string_15": null,
                       "po_box": "986548",
                       "udf_string_1": null,
                       "udf_string_16": null,
                       "udf_string_2": null,
                       "floor": 2,
                       "udf_string_3": null,
                       "area": "Centre",
                       "udf_string_4": null,
                       "district": "Makedonia",
                       "udf_string_5": null,
                       "udf_string_6": null,
                       "udf_string_7": null,
                       "state": "Active",
                       "udf_string_8": null,
                       "udf_string_9": null,
                       "country":
                       {
                           "name": "GREECE",
                           "id": "209"
                       },
                       "id": "5FDA3D490F36322B44AB621BDE288ECC",
                       "postal_code": "7061",
                       "udf_date_1": null,
                       "udf_date_2": null,
                       "udf_date_3": null,
                       "udf_date_4": null,
                       "po_box_postal_code": "986548-1",
                       "apartment_number": "203",
                       "town_city": "Thessaloniki",
                       "type": "Home",
                       "municipality": "voria ellada"
                   },
                   {
                       "care_of": "MML",
                       "street_number": "12",
                       "udf_string_10": null,
                       "udf_float_1": null,
                       "udf_string_11": null,
                       "street_name": "Olimpiados",
                       "udf_float_2": null,
                       "udf_string_12": null,
                       "udf_float_3": null,
                       "udf_string_13": null,
                       "udf_float_4": null,
                       "udf_string_14": null,
                       "udf_string_15": null,
                       "po_box": "986547",
                       "udf_string_1": null,
                       "udf_string_16": null,
                       "udf_string_2": null,
                       "floor": 12,
                       "udf_string_3": null,
                       "area": "kamara",
                       "udf_string_4": null,
                       "district": "makedonia",
                       "udf_string_5": null,
                       "udf_string_6": null,
                       "udf_string_7": null,
                       "state": "Active",
                       "udf_string_8": null,
                       "udf_string_9": null,
                       "country":
                       {
                           "name": "GREECE",
                           "id": "209"
                       },
                       "id": "D6B0827D10A0043ADE7198F0EC6D2D11",
                       "postal_code": "7060",
                       "udf_date_1": null,
                       "udf_date_2": null,
                       "udf_date_3": null,
                       "udf_date_4": null,
                       "po_box_postal_code": "986547-1",
                       "apartment_number": "4",
                       "town_city": "thessaloniki",
                       "type": "Business",
                       "municipality": "voria ellada"
                   }
               ],
               "title": "Miss",
               "company_profile":
               {
                   "tax_reference_number": null,
                   "annual_turnover": null,
                   "number_of_employees": null,
                   "profile_year": null,
                   "established_date": null,
                   "industry_sector":
                   {
                       "name": "EDUCATION",
                       "id": "AF6E0855324153EAB8B582A277147BCE",
                       "alternative_code": "1"
                   },
                   "registered_in_country": null,
                   "vat_registration_number": null,
                   "industry":
                   {
                       "name": "Interior Design",
                       "id": "06B638258885DA26FA2BD40D9128D04E",
                       "code": "INTDS"
                   },
                   "vat_registration_date": null,
                   "vat_registered_by": null,
                   "registration_number": null
               },
               "udf_date_1": "2014-05-05T15:49:59",
               "phones_set":
               [
                   {
                       "notes": "Honduras",
                       "udf_float_1": null,
                       "udf_float_2": null,
                       "udf_date_1": null,
                       "udf_float_3": null,
                       "udf_date_2": null,
                       "number": "988321236448",
                       "udf_float_4": null,
                       "udf_date_3": null,
                       "udf_date_4": null,
                       "udf_string_1": null,
                       "udf_string_2": null,
                       "udf_string_3": null,
                       "udf_string_4": null,
                       "udf_string_5": null,
                       "udf_string_6": null,
                       "udf_string_7": null,
                       "state": "Active",
                       "udf_string_8": null,
                       "country":
                       {
                           "name": "HONDURAS",
                           "id": "225"
                       },
                       "full_number": "504988321236448",
                       "type": "Landline",
                       "id": "F8E6B7A8135CA81CCEC810643E137CF6",
                       "area_code": "504"
                   }
               ],
               "udf_date_2": "2014-05-05T14:49:59",
               "udf_date_3": "2014-05-05T16:49:59",
               "udf_date_4": "2014-05-05T17:49:59",
               "udf_date_5": "2014-05-05T18:49:59",
               "udf_date_6": "2014-05-05T01:49:59",
               "demographics":
               {
                   "gender": "FEMALE",
                   "passport_issued_by_country":
                   {
                       "name": "HONDURAS",
                       "id": "225"
                   },
                   "passport_number": "15420910",
                   "social_security_number": "15420920",
                   "country_of_residence":
                   {
                       "name": "HONDURAS",
                       "id": "225"
                   },
                   "industry_sector":
                   {
                       "name": "EDUCATION",
                       "id": "AF6E0855324153EAB8B582A277147BCE",
                       "alternative_code": "1"
                   },
                   "date_of_birth":
                   {
                       "month": 5,
                       "day": 1,
                       "year": 1928
                   },
                   "name_day":
                   {
                       "month": 1,
                       "day": 7
                   },
                   "id_number": "154209",
                   "id_issued_by_country":
                   {
                       "name": "HONDURAS",
                       "id": "225"
                   },
                   "industry":
                   {
                       "name": "Interior Design",
                       "id": "06B638258885DA26FA2BD40D9128D04E",
                       "code": "INTDS"
                   }
               },
               "udf_date_7": "2014-05-05T19:49:59",
               "udf_date_8": "2014-05-05T20:49:59",
               "owned_by_group":
               {
                   "community_name": "Main Community",
                   "name": "Nicosia Office",
                   "id": "68D54DA033606669621E3D2E4B355DA0",
                   "description": null,
                   "alternative_code": "NO"
               },
               "middle_name": "A.",
               "emails_set":
               [
                   {
                       "udf_float_1": null,
                       "udf_float_2": null,
                       "udf_date_1": null,
                       "udf_float_3": null,
                       "udf_date_2": null,
                       "udf_float_4": null,
                       "udf_date_3": null,
                       "udf_date_4": null,
                       "udf_string_1": null,
                       "udf_string_2": null,
                       "udf_string_3": null,
                       "udf_string_4": null,
                       "udf_string_5": null,
                       "udf_string_6": null,
                       "udf_string_7": null,
                       "state": "Active",
                       "udf_string_8": null,
                       "type": "Business",
                       "id": "FAD6C644E1AE8216B05A56BAFE40CEFF",
                       "email": "mariaioannou@crm.com"
                   },
                   {
                       "udf_float_1": null,
                       "udf_float_2": null,
                       "udf_date_1": null,
                       "udf_float_3": null,
                       "udf_date_2": null,
                       "udf_float_4": null,
                       "udf_date_3": null,
                       "udf_date_4": null,
                       "udf_string_1": null,
                       "udf_string_2": null,
                       "udf_string_3": null,
                       "udf_string_4": null,
                       "udf_string_5": null,
                       "udf_string_6": null,
                       "udf_string_7": null,
                       "state": "Active",
                       "udf_string_8": null,
                       "type": "Personal",
                       "id": "77BC050D87E7FCA0D2EED9A5B9C4DCCB",
                       "email": "mariaioannou@personalcrm.com"
                   }
               ],
               "category":
               {
                   "name": "Clients",
                   "id": "BF9E138C477E2450F2DB2C40CB5DF7FB",
                   "code": "CLS"
               }
           },
           {
               "udf_string_10": "userfield10",
               "organizational_unit": 0,
               "udf_float_1": 10,
               "udf_string_11": "userfield11",
               "udf_float_2": 12,
               "udf_string_12": "userfield12",
               "udf_float_3": 13,
               "udf_string_13": "userfield13",
               "udf_float_4": 14,
               "udf_string_14": "userfield14",
               "udf_float_5": 5,
               "udf_string_15": "userfield15",
               "udf_string_1": "userfield1",
               "name": "Marios Christodoulou",
               "udf_string_16": "userfield16",
               "udf_float_6": 2,
               "udf_string_2": "userfield2",
               "udf_float_7": 1,
               "udf_string_3": "userfield3",
               "privacy_level":
               {
                   "number": null,
                   "hierarchy_level": 1,
                   "name": "3",
                   "id": "0BA1A4672D1A071351BB1297A99F2915"
               },
               "company_name": null,
               "udf_float_8": 7,
               "udf_string_4": "userfield4",
               "udf_string_5": "userfield5",
               "udf_string_6": "userfield6",
               "udf_string_7": "userfield7",
               "udf_string_8": "userfield8",
               "udf_string_9": "userfield9",
               "last_name": "Christodoulou",
               "id": "4F9B9A0E0CCB894101AE977EDCFC7E18",
               "relation_set":
               [
               ],
               "log_information":
               {
                   "updated_date": "2014-10-24T13:25:21",
                   "created_by_unit":
                   {
                       "community_name": "Main Community",
                       "group_name": "Main Group",
                       "name": "Admin Unit",
                       "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                       "description": "r1",
                       "alternative_code": "MG"
                   },
                   "created_date": "2014-10-24T11:11:14",
                   "updated_by_unit":
                   {
                       "community_name": "Main Community",
                       "group_name": "Main Group",
                       "name": "Admin Unit",
                       "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                       "description": "r1",
                       "alternative_code": "MG"
                   },
                   "created_by_user":
                   {
                       "person_name": "MPAdministrator",
                       "username": "MPAdministrator",
                       "id": "1",
                       "email": "mp@ministrator.com"
                   },
                   "updated_by_user":
                   {
                       "person_name": "MPAdministrator",
                       "username": "MPAdministrator",
                       "id": "1",
                       "email": "mp@ministrator.com"
                   }
               },
               "life_cycle_state": "MARKETING",
               "first_name": "Marios",
               "type": "PERSON",
               "addresses_set":
               [
                   {
                       "care_of": "MML",
                       "street_number": "23",
                       "udf_string_10": null,
                       "udf_float_1": null,
                       "udf_string_11": null,
                       "street_name": "Egnatias 102",
                       "udf_float_2": null,
                       "udf_string_12": null,
                       "udf_float_3": null,
                       "udf_string_13": null,
                       "udf_float_4": null,
                       "udf_string_14": null,
                       "udf_string_15": null,
                       "po_box": "986548",
                       "udf_string_1": null,
                       "udf_string_16": null,
                       "udf_string_2": null,
                       "floor": 2,
                       "udf_string_3": null,
                       "area": "Centre",
                       "udf_string_4": null,
                       "district": "Makedonia",
                       "udf_string_5": null,
                       "udf_string_6": null,
                       "udf_string_7": null,
                       "state": "Active",
                       "udf_string_8": null,
                       "udf_string_9": null,
                       "country":
                       {
                           "name": "UNITED KINGDOM",
                           "id": "126"
                       },
                       "id": "6CC99F6B9D87A44332E8A1789E2C2AC2",
                       "postal_code": "7061",
                       "udf_date_1": null,
                       "udf_date_2": null,
                       "udf_date_3": null,
                       "udf_date_4": null,
                       "po_box_postal_code": "986548-1",
                       "apartment_number": "203",
                       "town_city": "Thessaloniki",
                       "type": "Business",
                       "municipality": "voria ellada"
                   },
                   {
                       "care_of": "MML",
                       "street_number": "23",
                       "udf_string_10": null,
                       "udf_float_1": null,
                       "udf_string_11": null,
                       "street_name": "Egnatias 102",
                       "udf_float_2": null,
                       "udf_string_12": null,
                       "udf_float_3": null,
                       "udf_string_13": null,
                       "udf_float_4": null,
                       "udf_string_14": null,
                       "udf_string_15": null,
                       "po_box": "986548",
                       "udf_string_1": null,
                       "udf_string_16": null,
                       "udf_string_2": null,
                       "floor": 2,
                       "udf_string_3": null,
                       "area": "Centre",
                       "udf_string_4": null,
                       "district": "Makedonia",
                       "udf_string_5": null,
                       "udf_string_6": null,
                       "udf_string_7": null,
                       "state": "Active",
                       "udf_string_8": null,
                       "udf_string_9": null,
                       "country":
                       {
                           "name": "UNITED KINGDOM",
                           "id": "126"
                       },
                       "id": "3BC7A36F14234E81CD97BDF466F38FCE",
                       "postal_code": "7061",
                       "udf_date_1": null,
                       "udf_date_2": null,
                       "udf_date_3": null,
                       "udf_date_4": null,
                       "po_box_postal_code": "986548-1",
                       "apartment_number": "203",
                       "town_city": "Thessaloniki",
                       "type": "Home",
                       "municipality": "voria ellada"
                   }
               ],
               "title": "Sir",
               "company_profile":
               {
                   "tax_reference_number": null,
                   "annual_turnover": null,
                   "number_of_employees": null,
                   "profile_year": null,
                   "established_date": null,
                   "industry_sector": null,
                   "registered_in_country": null,
                   "vat_registration_number": null,
                   "industry":
                   {
                       "name": "Interior Design",
                       "id": "06B638258885DA26FA2BD40D9128D04E",
                       "code": "INTDS"
                   },
                   "vat_registration_date": null,
                   "vat_registered_by": null,
                   "registration_number": null
               },
               "udf_date_1": "2014-05-05T15:49:59",
               "phones_set":
               [
                   {
                       "notes": "Honduras",
                       "udf_float_1": null,
                       "udf_float_2": null,
                       "udf_date_1": null,
                       "udf_float_3": null,
                       "udf_date_2": null,
                       "number": "988321236448",
                       "udf_float_4": null,
                       "udf_date_3": null,
                       "udf_date_4": null,
                       "udf_string_1": null,
                       "udf_string_2": null,
                       "udf_string_3": null,
                       "udf_string_4": null,
                       "udf_string_5": null,
                       "udf_string_6": null,
                       "udf_string_7": null,
                       "state": "Active",
                       "udf_string_8": null,
                       "country":
                       {
                           "name": "UNITED KINGDOM",
                           "id": "126"
                       },
                       "full_number": "44988321236448",
                       "type": "Landline",
                       "id": "DBE65816407D8DF60C0E62BF87F07617",
                       "area_code": "44"
                   }
               ],
               "udf_date_2": "2014-05-05T14:49:59",
               "udf_date_3": "2014-05-05T16:49:59",
               "udf_date_4": "2014-05-05T17:49:59",
               "udf_date_5": "2014-05-05T18:49:59",
               "udf_date_6": "2014-05-05T01:49:59",
               "demographics":
               {
                   "gender": "MALE",
                   "passport_issued_by_country":
                   {
                       "name": "HONDURAS",
                       "id": "225"
                   },
                   "passport_number": "15420910",
                   "social_security_number": "15420920",
                   "country_of_residence":
                   {
                       "name": "UNITED KINGDOM",
                       "id": "126"
                   },
                   "industry_sector": null,
                   "date_of_birth":
                   {
                       "month": 5,
                       "day": 1,
                       "year": 1928
                   },
                   "name_day":
                   {
                       "month": 1,
                       "day": 7
                   },
                   "id_number": "154209",
                   "id_issued_by_country":
                   {
                       "name": "HONDURAS",
                       "id": "225"
                   },
                   "industry":
                   {
                       "name": "Interior Design",
                       "id": "06B638258885DA26FA2BD40D9128D04E",
                       "code": "INTDS"
                   }
               },
               "udf_date_7": "2014-05-05T19:49:59",
               "udf_date_8": "2014-05-05T20:49:59",
               "owned_by_group":
               {
                   "community_name": "Main Community",
                   "name": "Main Group",
                   "id": "84F33366CB592BAAE7E2044D93611C6A",
                   "description": "Main Group",
                   "alternative_code": "das"
               },
               "middle_name": "A.",
               "emails_set":
               [
                   {
                       "udf_float_1": 12,
                       "udf_float_2": 13,
                       "udf_date_1": "2014-09-12T09:44:20",
                       "udf_float_3": null,
                       "udf_date_2": null,
                       "udf_float_4": null,
                       "udf_date_3": null,
                       "udf_date_4": null,
                       "udf_string_1": "udf_string1",
                       "udf_string_2": "udf_string2",
                       "udf_string_3": "udf_string3",
                       "udf_string_4": "udf_string4",
                       "udf_string_5": "udf_string5",
                       "udf_string_6": "udf_string6",
                       "udf_string_7": "udf_string7",
                       "state": "Active",
                       "udf_string_8": "udf_string8",
                       "type": "Personal",
                       "id": "B4211DE145CD3AA03AAB93C61C9070AA",
                       "email": "mariaioannou@personalcrm.com"
                   },
                   {
                       "udf_float_1": null,
                       "udf_float_2": null,
                       "udf_date_1": null,
                       "udf_float_3": null,
                       "udf_date_2": null,
                       "udf_float_4": null,
                       "udf_date_3": null,
                       "udf_date_4": null,
                       "udf_string_1": null,
                       "udf_string_2": null,
                       "udf_string_3": null,
                       "udf_string_4": null,
                       "udf_string_5": null,
                       "udf_string_6": null,
                       "udf_string_7": null,
                       "state": "Active",
                       "udf_string_8": null,
                       "type": "Business",
                       "id": "42FB2FDF0CE0C2A9EC1CD173FCAEFB89",
                       "email": "mariaioannou@crm.com"
                   }
               ],
               "category":
               {
                   "name": "Clients",
                   "id": "BF9E138C477E2450F2DB2C40CB5DF7FB",
                   "code": "CLS"
               }
           }
       ]
    }

POST contact_information/create

This method creates a contact information. Single contact information can be created by each call. All addresses, phones and emails which are added on the contact information are added as active

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

type

(mandatory)

String

The type of the contact information which can be PERSON or COMPANY

title

(optional)

String

The title of the contact information. Applicable only if the type is PERSON

first_name

(mandatory on conditions)

String

The first name of the contact information. Applicable and mandatory only if the type is PERSON

middle_name

(optional)

String

The middle name of the contact information. Applicable only if the type is PERSON

last_name

(mandatory on conditions)

String

The last name of the contact information. Applicable and mandatory only if the type is PERSON

company_name

(mandatory on conditions)

Sting

The company name of the contact information. Applicable and mandatory only if the type is COMPANY

preferred_language

(optional)

String

The contact information's preferred language. The avialable options are:

ARA
DAN
ENG
EST
FIN
FRA
DEU
ELL
JPN
VIE
MAL
IND
TAI
LAV
LIT
NNO
POL
POR
RUS
SPA
SWE
UKR
CMN
TGL
HIN
CUSTOM1
CUSTOM2
CUSTOM3
CUSTOM4
CUSTOM5
CUSTOM6
CUSTOM7
CUSTOM8

Available from CRM.COM R12.0.0

category_identifier

(optional)

Identifier

The identifier of the contact category that will be associate with the contact information. The allowed contact category identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the contact category

name

(semi-optional)

String

The name of the category

code

(semi-optional)

String

The code of the category

owned_by_group_identifier

(optional)

Group identifier

The group owning the contact information. The allowed group identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the group

name

(semi-optional)

String

The code of the group

alternative_code

(semi-optional)

String

The alternative code of the group

privacy_level_identifier

(optional)

Privacy level identifier

The privacy level of the contact information. The allowed privacy level identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the privacy level

number

(semi-optional)

String

The number of the privacy level

notes

(optional)

String

Notes for the contact information

send_direct_marketing_material

(optional)

Boolean

The Contact Information's authorization setting for Direct Marketing

Available from CRM.COM R9.0.0

send_affiliate_marketing_material

(optional)

Boolean

The Contact Information's authorization setting for Affiliate Marketing

Available from CRM.COM R9.0.0

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_float_5

(optional)

Float

User Defined Field of type Float

udf_float_6

(optional)

Float

User Defined Field of type Float

udf_float_7

(optional)

Float

User Defined Field of type Float

udf_float_8

(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

udf_date_5

(optional)

Date

User Defined Field of type Date

udf_date_6

(optional)

Date

User Defined Field of type Date

udf_date_7

(optional)

Date

User Defined Field of type Date

udf_date_8

(optional)

Date

User Defined Field of type Date

demographics

(optional)

Demographics object

The demographics of the contact information. Applicable only if the type is PERSON

company_profile

(optional)

Company profile object

The company profile of the contact information. Applicable only if the type is COMPANY

address_set

(optional)

Address object

The addresses of the contact information

phone_set

(optional)

Phone object

The phone of the contact information

email_set

(optional)

Email object

The email of the contact information

relation_set

(optional)

Contact Information business and personal relation object

The business and personal relations of the contact information

Available from CRM.COM R5.0.0

fields_set

(optional)

List of Strings, comma separated

A list of fields that should be included in the results. If not specified then all the available fields will be returned

Available from CRM.COM R10.0.0

Referred Parameter Objects Data

demographics parameter object data

Name

Type

Description

gender

(optional)

String

The gender of the contact information which can be MALE or FEMALE

id_number

(optional)

String

The ID number of the contact information

id_number_expiration_date

(optional)

Date

The expiration date of the ID number

Available from CRM.COM R14.0.0

passport_number

(optional)

String

The passport number of the contact information

passport_number_expiration_date

(optional)

Date

The expiration date of the passport

Available from CRM.COM R14.0.0

social_security_number

(optional)

String

The social security number of the contact information

country_of_residence_identifier

(optional)

Country identifier

The country of residence of the contact information. 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

id_issued_by_country_identifier

(optional)

Country identifier

The ID issued country of the contact information. 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

passport_issued_by_country_identifier

(optional)

Country identifier

The passport issued country of the contact information. 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

industry_identifier

(optional)

Industry identifier

The industry of the contact information. The allowed industry identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the industry

name

(semi-optional)

String

The name of the industry

code

(semi-optional)

String

The alternative code of the industry

industry_sector_identifier

(optional)

Industry Sector identifier

The sector of the contact information. The allowed industry sector identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the industry sector

name

(semi-optional)

String

The name of the industry sector

alternative_code

(semi-optional)

String

The alternative code of the industry sector

date_of_birth

(optional)

Date of Birth Object

The date of birth of the contact information

name_day

(optional)

Name Day Object

The name day of the contact information

Referred Parameter Objects Data

date_of_birth object parameter data

Name

Type

Description

day

(optional)

Integer

The day of the retrieved date of birth

month

(optional)

Integer

The month of the retrieved date of birth

year

(optional)

Integer

The year of the retrieved date of birth

name_day object parameter data

Name

Type

Description

day

(optional)

Integer

The day of the retrieved name day

month

(optional)

Integer

The month of the retrieved name day

company_profile parameter object data

Name

Type

Description

profile_year

(optional)

Number

The profile year of the contact information

annual_turnover

(optional)

Number

The annual turnover of the contact information

established_date

(optional)

Date

The established date of the contact information

number_of_employees

(optional)

Number

The number of employees of the contact information

registration_number

(optional)

String

The registration number of the contact information

vat_registration_number

(optional)

String

The vat registration number of the contact information

vat_registered_by

(optional)

String

The vat registration by of the contact information

vat_registration_date

(optional)

Date

The vat registration date of the contact information

tax_reference_number

(optional)

String

The tax reference number of the contact information

registered_in_country_identifier

Country Identifier

The country of registration of the contact information. 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

industry_identifier

(optional)

Industry identifier

The industry of the contact information. The allowed industry identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the industry

name

(semi-optional)

String

The name of the industry

code

(semi-optional)

String

The alternative code of the industry

industry_sector_identifier

(optional)

Industry Sector identifier

The sector of the contact information. The allowed industry sector identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the industry sector

name

(semi-optional)

String

The name of the industry sector

alternative_code

(semi-optional)

String

The alternative code of the industry sector

address parameter object data

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

Name

Type

Description

type

(mandatory)

String

The type of the address which can be added

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

is_primary

(mandatory on conditions)

Boolean

Weather the address is the primary one

Applicable from CRM.COM R16.1.0 onwards

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)

String

The municipality of the address

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

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

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

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

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:

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

address_line_1

(mandatory)

String

The address line 1

address_line_2

(optional)

String

The address line 2

state_province_county

(optional)

String

The state or province or county 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

phone parameter object data

Name

Type

Description

type

(mandatory)

String

The type of the phone which can be

LANDLINE, MOBILE, FAX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5

is_primary

(mandatory on conditions)

Boolean

Weather the phone is the primary one

Applicable from CRM.COM R16.1.0 onwards

number

(mandatory)

String

The number of the phone

area_code

(optional)

String

The area code of the phone

country_identifier

(optional)

Country identifier

The country of the phone. 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

notes

(optional)

String

The notes of the phone

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_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

email parameter object data

Name	Type	Description
type (mandatory)	String	The type of the retrieved email which can be PERSONAL, BUSINESS, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5
is_primary (mandatory on conditions)	Boolean	Weather the email is the primary one Applicable from CRM.COM R16.1.0 onwards
email_address (mandatory)	String	The address of the retrieved email
notes (optional)	String	The notes of the retrieved email
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_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

contact_information_relation parameter object data

Name

Type

Description

type

(mandatory)

String

The type of the contact information business or personal relation which can be one of the following:

FAMILY MEMBER, EXTENDED FAMILY, PARTNER, CLOSE FRIEND, FRIEND, WORK COLLEAGUE, PARTNER COMPANY, CLIENT, EMPLOYER, EMPLOYEE, BUSINESS, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5

contact_information_identifier

(mandatory)

Contact Information Identifier

The related contact information. The allowed contact information identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the contact information

id_number

(semi-optional)

String

The ID number of the contact information

Applicable only for contact information that represent PERSON

passport_number

(semi-optional)

String

The passport number of the contact information

Applicable only for contact information that represent PERSON

social_security_number

(semi-optional)

String

The social security number of the contact information

Applicable only for contact information that represent PERSON

vat_registration_number

(semi-optional)

String

The VAT registration number of the contact information

Applicable only for contact information that represent COMPANY

registration_number

(semi-optional)

String

The registration number of the contact information

Applicable only for contact information that represent COMPANY

Available from CRM.COM R14.0.0

notes

(optional)

String

Notes for the contact information business or personal relation

Restrictions

It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Name	Type	Description
id	String	The ID of the retrieved contact information
type	String	The type of the retrieved contact information which can be PERSON or COMPANY
life_cycle_state	String	The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL
name	String	The full name of the retrieved contact information
title	String	The title of the retrieved contact information
first_name	String	The first name of the retrieved contact information
middle_name	String	The middle name of the retrieved contact information
last_name	String	The last name of the retrieved contact information
company_name	Sting	The company name of the retrieved contact information
notes	String	Notes for the contact information
organizational_unit	Integer	Indicates whether a contacts belongs to an organisational unit or not
preferred_language	String	The Contact Information's preferred language. The available values are: ARA DAN ENG EST FIN FRA DEU ELL JPN VIE MAL IND TAI LAV LIT NNO POL POR RUS SPA SWE UKR CMN TGL HIN CUSTOM1 CUSTOM2 CUSTOM3 CUSTOM4 CUSTOM5 CUSTOM6 CUSTOM7 CUSTOM8 Available from CRM.COM R12.0.0
udf_string_1	String	User Defined Field of type String
udf_string_2	String	User Defined Field of type String
udf_string_3	String	User Defined Field of type String
udf_string_4	String	User Defined Field of type String
udf_string_5	String	User Defined Field of type String
udf_string_6	String	User Defined Field of type String
udf_string_7	String	User Defined Field of type String
udf_string_8	String	User Defined Field of type String
udf_string_9	String	User Defined Field of type String
udf_string_10	String	User Defined Field of type String
udf_string_11	String	User Defined Field of type String
udf_string_12	String	User Defined Field of type String
udf_string_13	String	User Defined Field of type String
udf_string_14	String	User Defined Field of type String
udf_string_15	String	User Defined Field of type String
udf_string_16	String	User Defined Field of type String
udf_float_1	Float	User Defined Field of type Float
udf_float_2	Float	User Defined Field of type Float
udf_float_3	Float	User Defined Field of type Float
udf_float_4	Float	User Defined Field of type Float
udf_float_5	Float	User Defined Field of type Float
udf_float_6	Float	User Defined Field of type Float
udf_float_7	Float	User Defined Field of type Float
udf_float_8	Float	User Defined Field of type Float
udf_date_1	Date	User Defined Field of type Date
udf_date_2	Date	User Defined Field of type Date
udf_date_3	Date	User Defined Field of type Date
udf_date_4	Date	User Defined Field of type Date
udf_date_5	Date	User Defined Field of type Date
udf_date_6	Date	User Defined Field of type Date
udf_date_7	Date	User Defined Field of type Date
udf_date_8	Date	User Defined Field of type Date
kyc_profile	KYC profile object	The KYC profile information of the retrieved contact information Available from CRM.COM R14.0.0
demographics	Demographics object	The demographics of the retrieved contact information
company_profile	Company profile object	The company profile of the retrieved contact information
category	Category object	The category of the retrieved contact information
owned_by_group	Group object	The group that is owning the contact information Deprecated from CRM.COM R18.0.0 (replaced with owned_by_business_unit)
owned_by_business_unit	Business Unit Object	The business unit that is owning the contact information Available from CRM.COM R18.0.0
privacy_level	Privacy level object	The contact information's privacy level
log_information	Log Information Object	The log information related with the retrieved accounts receivable
addresses_set	Set of Contact information address Object	The addresses of the retrieved contact information
phones_set	Set of Contact information phone Object	The phones of the retrieved contact information
emails_set	Set of Contact information email Object	The emails of the retrieved contact information
relation_set	Set of Contact Information business and personal relation Objects	The business and personal relations of the retrieved contact information
authorization_settings	Contact Information Authorization settings object	The contact information's authorization settings information Available from CRM.COM R9.0.0
consent_information	Contact Consent Object	The contact information's consent information Available from CRM.COM R14.1.0

Referred Objects Response Data

kyc profile object response data

Name	Type	Description
kyc_profile_name	String	The KYC profile of the retrieved contact information
kyc_profile_expiration_date	Date	The KYC profile's expiration date
kyc_profile_state	String	The KYC profile's life cycle state. Available values are: PENDING_VERIFICATION, VERIFIED, REFUTE, EXPIRED

demographics object response data

Name	Type	Description
gender	String	The gender of the retrieved contact information which can be MALE or FEMALE
id_number	String	The ID number of the retrieved contact information
id_number_expiration_date	Date	The ID number's expiration date of the retrieved contact information Available from CRM.COM R14.0.0
passport_number	String	The passport number of the retrieved contact information
passport_number_expiration_date	Date	The passport's expiration date of the retrieved contact information Available from CRM.COM R14.0.0
social_security_number	String	The social security number of the retrieved contact information
date_of_birth	Date of Birth Object	The date of birth of the retrieved contact information
name_day	Name Day Object	The name day of the retrieved contact information
country_of_residence	Country Object	The country of residence of the retrieved contact information
id_issued_by_country	Country Object	The ID issued country of retrieved contact information
passport_issued_by_country	Country Object	The passport issued country of retrieved contact information
industry	Industry Object	The industry of retrieved contact information
industry_sector	Industry sector Object	The sector of retrieved contact information

Referred Objects Response Data

date_of_birth object response data

Name	Type	Description
day	Integer	The day of the retrieved date of birth
month	Integer	The month of the retrieved date of birth
year	Integer	The year of the retrieved date of birth

name_day object response data

Name	Type	Description
day	Integer	The day of the retrieved name day
month	Integer	The month of the retrieved name day

country object response data

Name	Type	Description
id	String	The id of the retrieved country
name	String	The name of the retrieved country
alternative_code	String	The alternative code of the retrieved country
dialing_code	String	The dialing code of the retrieved country Available from CRM.COM R15.1.0
two_character_code	String	The two character code of the retrieved country
three_character_code	String	The three character code of the retrieved country
country_flag	Image Object	The flag of the retrieved country Available from CRM.COM R15.1.0

Referred Objects Response Data

country_flag object response data

Name	Type	Description
id	String	The ID of the retrieved country flag
file	File Object	The information of the attached file

Referred Objects Response Data

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

industry object response data

Name	Type	Description
id	String	The id of the retrieved industry
name	String	The name of the retrieved industry
code	String	The code of the retrieved industry

industry sector object response data

Name	Type	Description
id	String	The id of the retrieved industry sector
name	String	The name of the retrieved industry sector
alternative_code	String	The alternative code of the retrieved industry sector

company profile object response data

Name	Type	Description
profile_year	Number	The profile year of the retrieved contact information
annual_turnover	Number	The annual turnover of the retrieved contact information
established_date	Date	The established date of the retrieved contact information
number_of_employees	Number	The number of employees of the retrieved contact information
registration_number	String	The registration number of the retrieved contact information
vat_registration_number	String	The vat registration number of the retrieved contact information
vat_registered_by	String	The vat registration by of the retrieved contact information
vat_registration_date	Date	The vat registration date of the retrieved contact information
tax_reference_number	String	The tax referenece number of the retrieved contact information
registered_in_country	Country Object	The country of residence of the retrieved contact information
industry	Industry Object	The industry of retrieved contact information
industry_sector	Industry sector Object	The sector of retrieved contact information

Referred Objects Response Data

country object response data

Name	Type	Description
id	String	The id of the retrieved country
name	String	The name of the retrieved country
alternative_code	String	The alternative code of the retrieved country
dialing_code	String	The dialing code of the retrieved country Available from CRM.COM R15.1.0
two_character_code	String	The two character code of the retrieved country
three_character_code	String	The three character code of the retrieved country
country_flag	Image Object	The flag of the retrieved country Available from CRM.COM R15.1.0

Referred Objects Response Data

country_flag object response data

Name	Type	Description
id	String	The ID of the retrieved country flag
file	File Object	The information of the attached file

Referred Objects Response Data

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

industry object response data

Name	Type	Description
id	String	The id of the retrieved industry
name	String	The name of the retrieved industry
code	String	The code of the retrieved industry

industry sector object response data

Name	Type	Description
id	String	The id of the retrieved industry sector
name	String	The name of the retrieved industry sector
alternative_code	String	The alternative code of the retrieved industry sector

contact category object response data

Name	Type	Description
id	String	The id of the retrieved category
name	String	The name of the retrieved category
code	String	The code of the retrieved category

group object response data

Name	Type	Description
id	String	The ID of the retrieved group
name	String	The name of the retrieved group
community_name	String	The name of the community that the retrieved group belongs to
alternative_code	String	The alternative code of the retrieved group
unified_code	String	The unified code of the retrieved group Available from CRM.COM R16.2.2
description	String	The description of the retrieved group

business unit object response data

Name	Type	Description
id	String	The ID of the retrieved business unit
name	String	The name of the retrieved business unit
code	String	The code of the retrieved business unit
unified_code	String	The unified code of the retrieved business unit
description	String	The description of the retrieved business unit
parent_business_unit_name	String	The name of the parent business unit that the retrieved business unit belongs to

privacy_level object response data

Name	Type	Description
id	String	The id of the retrieved privacy level
number	String	The number of the retrieved privacy level
name	String	The name of the retrieved privacy level
hierarchy_level	String	The hierarchy level of the retrieved privacy level

log_information object response data

Name	Type	Description
created_date	Date	The date that the retrieved record was created
updated_date	Date	The last date that the retrieved record was updated
created_by_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
created_by_business_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Available from CRM.COM R18.0.0
created_by_user	User Object	The user that created the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled
updated_by_unit	Unit Object	The last unit that updated the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
updated_by_business_unit	Unit Object	The last unit that updated the retrieved record Available from CRM.COM R18.0.0
updated_by_user	User Object	The last user that updated the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

Referred Objects Response Data

unit object response data

Name	Type	Description
id	String	The ID of the retrieved unit
name	String	The name of the retrieved unit
group_name	String	The name of the group that the retrieved unit belongs to
community_name	String	The name of the community that the retrieved unit belongs to
alternative_code	String	The alternative code of the retrieved unit
description	String	The description of the retrieved unit

business unit object response data

Name	Type	Description
id	String	The ID of the retrieved business unit
name	String	The name of the retrieved business unit
code	String	The code of the retrieved business unit
unified_code	String	The unified code of the retrieved business unit
description	String	The description of the retrieved business unit
parent_business_unit_name	String	The name of the parent business unit that the retrieved business unit belongs to

user object response data

Name	Type	Description
id	String	The ID of the retrieved user
username	String	The user name of the retrieved user
person_name	String	The full name of the retrieved user
email	String	The email of the retrieved user

address object response data

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

Name	Type	Description
id	String	The ID of the retrieved address
type	String	The type of the retrieved address which can be HOME, BUSINESS, POBOX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5
postal_code	String	The postal code of the retrieved address
street_name	String	The street name of the retrieved address
street_number	String	The street number of the retrieved address
floor	Integer	The floor of the retrieved address
apartment_number	String	The apartment number of the retrieved address
area	String	The area of the retrieved address
town_city	String	The town / city of the retrieved address
district	String	The district of the retrieved address
municipality	String	The municipality of the retrieved address
po_box	String	The PO box of the retrieved address
po_box_postal_code	String	The PO box postal code of the retrieved address
care_of	String	The care of person of the retrieved address
udf_string_1	String	User Defined Field of type String
udf_string_2	String	User Defined Field of type String
udf_string_3	String	User Defined Field of type String
udf_string_4	String	User Defined Field of type String
udf_string_5	String	User Defined Field of type String
udf_string_6	String	User Defined Field of type String
udf_string_7	String	User Defined Field of type String
udf_string_8	String	User Defined Field of type String
udf_string_9	String	User Defined Field of type String
udf_string_10	String	User Defined Field of type String
udf_string_11	String	User Defined Field of type String
udf_string_12	String	User Defined Field of type String
udf_string_13	String	User Defined Field of type String
udf_string_14	String	User Defined Field of type String
udf_string_15	String	User Defined Field of type String
udf_string_16	String	User Defined Field of type String
udf_float_1	Float	User Defined Field of type Float
udf_float_2	Float	User Defined Field of type Float
udf_float_3	Float	User Defined Field of type Float
udf_float_4	Float	User Defined Field of type Float
udf_date_1	Date	User Defined Field of type Date
udf_date_2	Date	User Defined Field of type Date
udf_date_3	Date	User Defined Field of type Date
udf_date_4	Date	User Defined Field of type Date
country	Country Object	The country of the retrieved address
is_primary	Boolean	Defines if the address is the contact's primary address or not. Available from CRM.COM R15

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

Name	Type	Description
id	String	The ID of the retrieved address
type	String	The type of the retrieved address which can be HOME, BUSINESS, POBOX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5
postal_code	String	The postal code of the retrieved address
town_city	String	The town / city of the retrieved address
address_line_1	String	The address line 1
address_line_2	String	The address line 2
state_province_county	String	The state or province or county of the address.
udf_string_1	String	User Defined Field of type String
udf_string_2	String	User Defined Field of type String
udf_string_3	String	User Defined Field of type String
udf_string_4	String	User Defined Field of type String
udf_string_5	String	User Defined Field of type String
udf_string_6	String	User Defined Field of type String
udf_string_7	String	User Defined Field of type String
udf_string_8	String	User Defined Field of type String
udf_string_9	String	User Defined Field of type String
udf_string_10	String	User Defined Field of type String
udf_string_11	String	User Defined Field of type String
udf_string_12	String	User Defined Field of type String
udf_string_13	String	User Defined Field of type String
udf_string_14	String	User Defined Field of type String
udf_string_15	String	User Defined Field of type String
udf_string_16	String	User Defined Field of type String
udf_float_1	Float	User Defined Field of type Float
udf_float_2	Float	User Defined Field of type Float
udf_float_3	Float	User Defined Field of type Float
udf_float_4	Float	User Defined Field of type Float
udf_date_1	Date	User Defined Field of type Date
udf_date_2	Date	User Defined Field of type Date
udf_date_3	Date	User Defined Field of type Date
udf_date_4	Date	User Defined Field of type Date
country	Country Object	The country of the retrieved address
is_primary	Boolean	Defines if the address is the contact's primary address or not. Available from CRM.COM R15

Referred Objects Response Data

country object response data

Name	Type	Description
id	String	The id of the retrieved country
name	String	The name of the retrieved country
alternative_code	String	The alternative code of the retrieved country
dialing_code	String	The dialing code of the retrieved country Available from CRM.COM R15.1.0
two_character_code	String	The two character code of the retrieved country
three_character_code	String	The three character code of the retrieved country
country_flag	Image Object	The flag of the retrieved country Available from CRM.COM R15.1.0

Referred Objects Response Data

country_flag object response data

Name	Type	Description
id	String	The ID of the retrieved country flag
file	File Object	The information of the attached file

Referred Objects Response Data

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

phone object response data

Name	Type	Description
id	String	The ID of the retrieved phone
type	String	The type of the retrieved phone which can be LANDLINE, MOBILE, FAX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5
number	String	The number of the retrieved phone
area_code	String	The area code of the retrieved phone
full_number	String	The full number of the retrieved phone
notes	String	The notes of the retrieved phone
udf_string_1	String	User Defined Field of type String
udf_string_2	String	User Defined Field of type String
udf_string_3	String	User Defined Field of type String
udf_string_4	String	User Defined Field of type String
udf_string_5	String	User Defined Field of type String
udf_string_6	String	User Defined Field of type String
udf_string_7	String	User Defined Field of type String
udf_string_8	String	User Defined Field of type String
udf_float_1	Float	User Defined Field of type Float
udf_float_2	Float	User Defined Field of type Float
udf_float_3	Float	User Defined Field of type Float
udf_float_4	Float	User Defined Field of type Float
udf_date_1	Date	User Defined Field of type Date
udf_date_2	Date	User Defined Field of type Date
udf_date_3	Date	User Defined Field of type Date
udf_date_4	Date	User Defined Field of type Date
country	Country Object	The country of the retrieved phone
is_primary	Boolean	Defines if the phone is the contact's primary phone or not. Available from CRM.COM R15

Referred Objects Response Data

country object response data

Name	Type	Description
id	String	The id of the retrieved country
name	String	The name of the retrieved country
alternative_code	String	The alternative code of the retrieved country
dialing_code	String	The dialing code of the retrieved country Available from CRM.COM R15.1.0
two_character_code	String	The two character code of the retrieved country
three_character_code	String	The three character code of the retrieved country
country_flag	Image Object	The flag of the retrieved country Available from CRM.COM R15.1.0

Referred Objects Response Data

country_flag object response data

Name	Type	Description
id	String	The ID of the retrieved country flag
file	File Object	The information of the attached file

Referred Objects Response Data

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

email object response data

Name	Type	Description
id	String	The ID of the retrieved email
type	String	The type of the retrieved email which can be PERSONAL, BUSINESS, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5
email_address	String	The address of the retrieved email
notes	String	The notes of the retrieved email
udf_string_1	String	User Defined Field of type String
udf_string_2	String	User Defined Field of type String
udf_string_3	String	User Defined Field of type String
udf_string_4	String	User Defined Field of type String
udf_string_5	String	User Defined Field of type String
udf_string_6	String	User Defined Field of type String
udf_string_7	String	User Defined Field of type String
udf_string_8	String	User Defined Field of type String
udf_float_1	Float	User Defined Field of type Float
udf_float_2	Float	User Defined Field of type Float
udf_float_3	Float	User Defined Field of type Float
udf_float_4	Float	User Defined Field of type Float
udf_date_1	Date	User Defined Field of type Date
udf_date_2	Date	User Defined Field of type Date
udf_date_3	Date	User Defined Field of type Date
udf_date_4	Date	User Defined Field of type Date
is_primary	Boolean	Defines if the email is the contact's primary email or not. Available from CRM.COM R15

contact_information_relation object response data

Name	Type	Description
id	String	The ID of the retrieved contact information business or personal relation
type	String	The type of the retrieved contact information business or personal relation which can be FAMILY MEMBER, EXTENDED FAMILY, PARTNER, CLOSE FRIEND, FRIEND, WORK COLLEAGUE, PARTNER COMPANY, CLIENT, EMPLOYER, EMPLOYEE, BUSINESS, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5
relation_type	String	The relation type of the retrieved contact information The supported values are INWARD, OUTWARD Available from CRM.COM R14.2.0 Deprecated from CRM.COM R17
notes	String	The notes of the retrieved contact information business or personal relation
contact_information	Contact Information Object	The related contact information

Referred Response Objects Data

contact_information object response data

Name	Type	Description
id	String	The ID of the retrieved contact information
type	String	The type of the retrieved contact information which can be PERSON or COMPANY
life_cycle_state	String	The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL
name	String	The full name of the retrieved contact information
first_name	String	The first name of the retrieved contact information
middle_name	String	The middle name of the retrieved contact information
last_name	String	The last name of the retrieved contact information
title	String	The title of the retrieved contact information
company_name	Sting	The company name of the retrieved contact information
demographics	Demographics Object	The demographics information of the retrieved contact information
company_profile	Company profile object	The company profile of the retrieve contact information

Referred Objects Response Data

demographics object response data

Name	Type	Description
gender	String	The gender of the retrieved contact information which can be MALE or FEMALE
id_number	String	The ID number of the retrieved contact information
id_number_expiration_date	Date	The ID number's expiration date of the retrieved contact information Available from CRM.COM R14.0.0
passport_number	String	The passport number of the retrieved contact information
passport_number_expiration_date	Date	The passport's expiration date of the retrieved contact information Available from CRM.COM R14.0.0
social_security_number	String	The social security number of the retrieved contact information
date_of_birth	Date of Birth Object	The date of birth of the retrieved contact information
name_day	Name Day Object	The name day of the retrieved contact information
country_of_residence	Country Object	The country of residence of the retrieved contact information
id_issued_by_country	Country Object	The ID issued country of retrieved contact information
passport_issued_by_country	Country Object	The passport issued country of retrieved contact information
industry	Industry Object	The industry of retrieved contact information
industry_sector	Industry sector Object	The sector of retrieved contact information

Referred Objects Response Data

date_of_birth object response data

Name	Type	Description
day	Integer	The day of the retrieved date of birth
month	Integer	The month of the retrieved date of birth
year	Integer	The year of the retrieved date of birth

name_day object response data

Name	Type	Description
day	Integer	The day of the retrieved name day
month	Integer	The month of the retrieved name day

country object response data

Name	Type	Description
id	String	The id of the retrieved country
name	String	The name of the retrieved country
alternative_code	String	The alternative code of the retrieved country
dialing_code	String	The dialing code of the retrieved country Available from CRM.COM R15.1.0
two_character_code	String	The two character code of the retrieved country
three_character_code	String	The three character code of the retrieved country
country_flag	Image Object	The flag of the retrieved country Available from CRM.COM R15.1.0

Referred Objects Response Data

country_flag object response data

Name	Type	Description
id	String	The ID of the retrieved country flag
file	File Object	The information of the attached file

Referred Objects Response Data

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

industry object response data

Name	Type	Description
id	String	The id of the retrieved industry
name	String	The name of the retrieved industry
code	String	The code of the retrieved industry

industry sector object response data

Name	Type	Description
id	String	The id of the retrieved industry sector
name	String	The name of the retrieved industry sector
alternative_code	String	The alternative code of the retrieved industry sector

company profile object response data

Name	Type	Description
profile_year	Number	The profile year of the retrieved contact information
annual_turnover	Number	The annual turnover of the retrieved contact information
established_date	Date	The established date of the retrieved contact information
number_of_employees	Number	The number of employees of the retrieved contact information
registration_number	String	The registration number of the retrieved contact information
vat_registration_number	String	The vat registration number of the retrieved contact information
vat_registered_by	String	The vat registration by of the retrieved contact information
vat_registration_date	Date	The vat registration date of the retrieved contact information
tax_reference_number	String	The tax referenece number of the retrieved contact information
registered_in_country	Country Object	The country of residence of the retrieved contact information
industry	Industry Object	The industry of retrieved contact information
industry_sector	Industry sector Object	The sector of retrieved contact information

Referred Objects Response Data

country object response data

Name	Type	Description
id	String	The id of the retrieved country
name	String	The name of the retrieved country
alternative_code	String	The alternative code of the retrieved country
dialing_code	String	The dialing code of the retrieved country Available from CRM.COM R15.1.0
two_character_code	String	The two character code of the retrieved country
three_character_code	String	The three character code of the retrieved country
country_flag	Image Object	The flag of the retrieved country Available from CRM.COM R15.1.0

Referred Objects Response Data

country_flag object response data

Name	Type	Description
id	String	The ID of the retrieved country flag
file	File Object	The information of the attached file

Referred Objects Response Data

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

industry object response data

Name	Type	Description
id	String	The id of the retrieved industry
name	String	The name of the retrieved industry
code	String	The code of the retrieved industry

industry sector object response data

Name	Type	Description
id	String	The id of the retrieved industry sector
name	String	The name of the retrieved industry sector
alternative_code	String	The alternative code of the retrieved industry sector

contact_information_authorization object response data

Name	Type	Description
send_direct_ marketing_material	Boolean	Defines whether the contact wants to be contacted for Direct Marketing purposes
direct_marketing_setting_updated_date	Date	The last date that the contact information's authorization setting for Direct Marketing was updated
send_affiliate_ marketing_material	Boolean	Defines whether the contact wants to be contacted for Affiliate Marketing purposes
affiliate_marketing_setting_updated_date	Date	The last date that the contact information's authorization setting for Affiliate Marketing was updated
direct_marketing_setting_updated_by_user	User Object	The name of the last user that updated the contact information's authorization setting for Affiliate Marketing
affiliated_marketing_setting_updated_by_user	User Object	The name of the last user that updated the contact information's authorization setting for Affiliate Marketing

Referred Objects Response Data

user object response data

Name	Type	Description
id	String	The ID of the retrieved user
username	String	The user name of the retrieved user
person_name	String	The full name of the retrieved user
email	String	The email of the retrieved user

contact consent object response data

Name	Type	Description
id	String	The ID of the retrieved contact information
contact_consent_state	String	The state of the Contact's Consent. Applicable values are: PENDING ACCEPTED REJECTED WITHDRAWN
contact_consent_updated_date	Date	The updated date of the Contact's Consent
contact_consent_form	Attachments Object	The Contact's accepted Consent Form. Applicable only if Consent State is ACCEPTED

Referred Objects Response Data

Attachments object response data

Name	Type	Description
id	String	The ID of the retrieved attachment
entity	String	The name of the entity related with the attachment. The supported entities are the following: ACCOUNTSRECEIVABLE ACTIVITIES COMMUNICATIONS COMMUNICATIONTEMPLATES CONTACTINFORMATION INSTALLEDITEMS JOBS LEADS PRODUCTS SERVICEREQUESTS ATTACHMENTSLIBRARY From CRM.COM R12.2.0, ATTACHMENTSLIBRARY is available From CRM.COM R14.0.0, COMMUNICATIONTEMPLATES is available
entity_id	String	The ID of the entity related with the attachment.
url	String	The attached URL. This information is empty if the attachment is a file.
notes	String	The comments related with the retrieved attachment
classification	Attachments Classification Object	The classification of the attachment Available from CRM.COM R12.2.0
file	File Object	The information of the attached file. This information is empty if the attachment is a URL.
log_information	Log Information Object	The log information of the retrieved attachment

Referred Objects Response Data

classification object response data

Name	Type	Description
id	String	The id of the retrieved attachment classification
name	String	The name of the retrieved attachment classification
alternative_code	String	The alternative code of the retrieved attachment classification

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

log_information object response data

Name	Type	Description
created_date	Date	The date that the retrieved record was created
updated_date	Date	The last date that the retrieved record was updated
created_by_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
created_by_business_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Available from CRM.COM R18.0.0
created_by_user	User Object	The user that created the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled
updated_by_unit	Unit Object	The last unit that updated the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
updated_by_business_unit	Unit Object	The last unit that updated the retrieved record Available from CRM.COM R18.0.0
updated_by_user	User Object	The last user that updated the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

Referred Objects Response Data

unit object response data

Name	Type	Description
id	String	The ID of the retrieved unit
name	String	The name of the retrieved unit
group_name	String	The name of the group that the retrieved unit belongs to
community_name	String	The name of the community that the retrieved unit belongs to
alternative_code	String	The alternative code of the retrieved unit
description	String	The description of the retrieved unit

business unit object response data

Name	Type	Description
id	String	The ID of the retrieved business unit
name	String	The name of the retrieved business unit
code	String	The code of the retrieved business unit
unified_code	String	The unified code of the retrieved business unit
description	String	The description of the retrieved business unit
parent_business_unit_name	String	The name of the parent business unit that the retrieved business unit belongs to

user object response data

Name	Type	Description
id	String	The ID of the retrieved user
username	String	The user name of the retrieved user
person_name	String	The full name of the retrieved user
email	String	The email of the retrieved user

Examples

Example 1

HTTP Method: POST

Request:

Body:

{
 "token":"FA32A9008D7348F5984DEA452FA65B5A", 
"type":"PERSON",
  "title":"Sir",
  "first_name":"Louis",
  "middle_name":"Aloz",
  "last_name":"Kozior",
  "category_identifier":{"name":"Contact Category"},
  "owned_by_group_identifier":{"name":"Main Group"},
  "privacy_level_identifier":{"number":"8"},
  "notes": "Family",
  "udf_string_1":"udf string 1",
   "udf_string_2":"udf string 2",
   "udf_string_3":"udf string 3",
   "udf_string_4":"udf string 4",
   "udf_string_5":"udf string 5",
   "udf_string_6":"udf string 6",
   "udf_string_7":"udf string 7",
   "udf_string_8":"udf string 8",
   "udf_string_8":"udf string 9",
   "udf_string_8":"udf string 10",
   "udf_string_8":"udf string 11",
   "udf_string_8":"udf string 12",
   "udf_string_8":"udf string 13",
   "udf_string_8":"udf string 14",
   "udf_string_8":"udf string 15",
   "udf_string_8":"udf string 16",
   "udf_float_1":10,
   "udf_float_2":20,
   "udf_float_3":30,
   "udf_float_4":40,
   "udf_float_5":50,
   "udf_float_6":60,
   "udf_float_7":70,
   "udf_float_8":80,
   "udf_date_1":"2014-05-05T15:49:59",
   "udf_date_2":"2014-06-05T15:49:59",
   "udf_date_3":"2014-07-05T15:49:59",
   "udf_date_4":"2014-08-05T15:49:59",
   "demographics":
   {
     "gender":"FEMALE",
     "id_number":"AB112234",
     "passport_number":"CD112234",
     "social_security_number":"EF112234",
     "country_of_residence_identifier":{"name":"CYPRUS"},
     "id_issued_by_country_identifier":{"name":"CYPRUS"},
     "passport_issued_by_country_identifier":{"name":"GREECE"},
     "industry_identifier":{"name":"Marketing"},
     "industry_sector_identifier":{"name":"FOREX"},
     "date_of_birth":{
                       "day":12,
                       "month":5,
                       "year":1981                     
                  },
     "name_day":     {
                       "day":18,
                       "month":8                     
                   }
   },
    "address_set": [
                     {
                       "type": "HOME",
                       "postal_code": "3020",
                       "street_name": "Ilia Papakiriakou",
                       "street_number" : "8",
                       "floor":2,
                       "apartment_number":"202",
                       "area": "Plati",
                       "town_city":"Aglanjia",
                       "district":"Nicosia",
                       "municipality":"Aglanjia",
                       "country_identifier":{	"two_character_code": "CY" },
                       "po_box":"70022",
                       "po_box_postal_code":"AG70022",
                       "care_of":"Maria Kyriacou",
                       "notes":"To be reviewed",
                       "udf_string_1":"udf string 1",
            "udf_string_2":"udf string 2",
            "udf_string_3":"udf string 3",
               "udf_string_4":"udf string 4",
              "udf_string_5":"udf string 5",
              "udf_string_6":"udf string 6",
              "udf_string_7":"udf string 7",
              "udf_string_8":"udf string 8",
             "udf_string_8":"udf string 9",
             "udf_string_8":"udf string 10",
              "udf_string_8":"udf string 11",
              "udf_string_8":"udf string 12",
              "udf_string_8":"udf string 13",
              "udf_string_8":"udf string 14",
              "udf_string_8":"udf string 15",
              "udf_string_8":"udf string 16",
              "udf_float_1":10,
              "udf_float_2":20,
              "udf_float_3":30,
              "udf_float_4":40,
              "udf_float_5":50,
              "udf_float_6":60,
              "udf_float_7":70,
              "udf_float_8":80,
             "udf_date_1":"2014-05-05T15:49:59",
             "udf_date_2":"2014-06-05T15:49:59",
             "udf_date_3":"2014-07-05T15:49:59",
             "udf_date_4":"2014-08-05T15:49:59"
             }
          ],
   "phone_set": [
                 {
                    "type": "LANDLINE",
                    "number":"22114455"
                 }
               ],
  "email_set": [
                 {
                    "type": "PERSONAL",
                    "email_address": "brianakozior@gmail.com"
                  }
                ],
   "relation_set": [
                  {
                "type":"FAMILY_MEMBER",
                "contact_information_identifier":{"id_number" : "142536"}
              }
                ]
}

Response:

{
       "status":
       {
           "message": null,
           "description": null,
           "code": "OK"
       },
       "data":
       {
           "last_name": "Kozior",
           "life_cycle_state": "MARKETING",
           "middle_name": "Aloz",
           "company_profile": null,
           "title": "Sir",
           "type": "PERSON",
           "first_name": "Louis",
           "name": "Louis Kozior",
           "id": "1F1D2D0DFD164BFA801BE87CA9E33915",
           "company_name": null,
           "demographics":
           {
               "gender": "FEMALE",
               "passport_issued_by_country":
               {
                   "three_character_code": "GRC",
                   "two_character_code": "GR",
                   "name": "GREECE",
                   "id": "209",
                   "alternative_code": null
               },
               "passport_number": "CD112234",
               "social_security_number": "EF112234",
               "country_of_residence":
               {
                   "three_character_code": "CYP",
                   "two_character_code": "CY",
                   "name": "CYPRUS",
                   "id": "181",
                   "alternative_code": null
               },
               "industry_sector":
               {
                   "name": "FOREX",
                   "id": "D8ACF18AB4494AD33738A9F4C94E6995",
                   "alternative_code": "FRX"
               },
               "date_of_birth":
               {
                   "month": 5,
                   "day": 12,
                   "year": 1981
               },
               "name_day":
               {
                   "month": 8,
                   "day": 18
               },
               "id_number": "AB112234",
               "id_issued_by_country":
               {
                   "three_character_code": "CYP",
                   "two_character_code": "CY",
                   "name": "CYPRUS",
                   "id": "181",
                   "alternative_code": null
               },
               "industry":
               {
                   "name": "Marketing",
                   "id": "31BC2070C79EAE5455BFAD41599C5190",
                   "code": "MK"
               }
           }
       }
}

Example 2

HTTP Method: POST

Request:

Body:

{
 "token":"656AE15BA46552027451AD4C319B8B92",  
"type":"COMPANY",
 "company_name":"Koziors",
  "category_identifier":{"name":"Company Category"},
  "owned_by_group_identifier":{"name":"Main Group"},
  "privacy_level_identifier":{"number":"8"},
  "notes": "Company",
  "udf_string_1":"udf string 1",
   "udf_string_2":"udf string 2",
   "udf_string_3":"udf string 3",
   "udf_string_4":"udf string 4",
   "udf_string_5":"udf string 5",
   "udf_string_6":"udf string 6",
   "udf_string_7":"udf string 7",
   "udf_string_8":"udf string 8",
   "udf_string_8":"udf string 9",
   "udf_string_8":"udf string 10",
   "udf_string_8":"udf string 11",
   "udf_string_8":"udf string 12",
   "udf_string_8":"udf string 13",
   "udf_string_8":"udf string 14",
   "udf_string_8":"udf string 15",
   "udf_string_8":"udf string 16",
   "udf_float_1":10,
   "udf_float_2":20,
   "udf_float_3":30,
   "udf_float_4":40,
   "udf_float_5":50,
   "udf_float_6":60,
   "udf_float_7":70,
   "udf_float_8":80,
   "udf_date_1":"2014-05-05T15:49:59",
   "udf_date_2":"2014-06-05T15:49:59",
   "udf_date_3":"2014-07-05T15:49:59",
   "udf_date_4":"2014-08-05T15:49:59",
   "company_profile":
   {
    "profile_year" : 1999,
    "annual_turnover":1999,
    "established_date" :"1999-05-05T15:49:59",
    "number_of_employees" : 4,
    "registration_number" : "KZ126591",
    "vat_registration_number" : "126591",
    "vat_registered_by" : "Manager",
    "vat_registration_date":"2000-05-05T15:49:59",
    "tax_reference_number":"126591",
    "registered_in_country_identifier" : {"name":"CYPRUS"},
    "industry_identifier":{"name":"Interior Design"},
    "industry_sector_identifier":{"name":"GOVERNMENTAL"}
  },
    "address_set": [
                     {
                       "type": "HOME",
                       "postal_code": "3020",
                       "street_name": "Ilia Papakiriakou",
                       "street_number" : "8",
                       "floor":2,
                       "apartment_number":"202",
                       "area": "Plati",
                       "town_city":"Aglanjia",
                       "district":"Nicosia",
                       "municipality":"Aglanjia",
                       "country_identifier":{"name":"CYPRUS"},
                       "po_box":"70022",
                       "po_box_postal_code":"AG70022",
                       "care_of":"Maria Kyriacou",
                       "notes":"To be reviewed",
                       "udf_string_1":"udf string 1",
            "udf_string_2":"udf string 2",
            "udf_string_3":"udf string 3",
               "udf_string_4":"udf string 4",
              "udf_string_5":"udf string 5",
              "udf_string_6":"udf string 6",
              "udf_string_7":"udf string 7",
              "udf_string_8":"udf string 8",
             "udf_string_8":"udf string 9",
             "udf_string_8":"udf string 10",
              "udf_string_8":"udf string 11",
              "udf_string_8":"udf string 12",
              "udf_string_8":"udf string 13",
              "udf_string_8":"udf string 14",
              "udf_string_8":"udf string 15",
              "udf_string_8":"udf string 16",
              "udf_float_1":10,
              "udf_float_2":20,
              "udf_float_3":30,
              "udf_float_4":40,
              "udf_float_5":50,
              "udf_float_6":60,
              "udf_float_7":70,
              "udf_float_8":80,
             "udf_date_1":"2014-05-05T15:49:59",
             "udf_date_2":"2014-06-05T15:49:59",
             "udf_date_3":"2014-07-05T15:49:59",
             "udf_date_4":"2014-08-05T15:49:59"
             }
          ],
   "phone_set": [
                 {
                    "type": "LANDLINE",
                    "number":"22114455"
                 }
               ],
  "email_set": [
                 {
                    "type": "PERSONAL",
                    "email_address": "brianakozior@gmail.com"
                  }
                ],
   "relation_set": [
                  {
                "type":"PARTNER_COMPANY",
                "contact_information_identifier":{"id_number" : "AB112233"}
              }
                ]
}

Response:

{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "last_name": null,
        "life_cycle_state": "MARKETING",
        "middle_name": null,
        "company_profile":
        {
            "tax_reference_number": "126591",
            "annual_turnover": 1999,
            "number_of_employees": 4,
            "profile_year": 1999,
            "established_date": "1999-05-05T15:49:59",
            "industry_sector":
            {
                "name": "GOVERNMENTAL",
                "id": "A9BDEBD4D8FAEDB0BACE40C041156D12",
                "alternative_code": "GOV"
            },
            "registered_in_country":
            {
                "name": "CYPRUS",
                "id": "181"
            },
            "vat_registration_number": "126591",
            "industry":
            {
                "name": "Interior Design",
                "id": "06B638258885DA26FA2BD40D9128D04E",
                "code": "INTDS"
            },
            "vat_registration_date": "2000-05-05T15:49:59",
            "vat_registered_by": "Manager",
            "registration_number": "KZ126591"
        },
        "title": null,
        "type": "COMPANY",
        "first_name": null,
        "name": "Koziors",
        "id": "5B1E5A7D3D1F41E159C58870367D1A76",
        "company_name": "Koziors",
        "demographics": null
    }
}

Example 3

HTTP Method: POST

Request:

Body:

{
  "token":"{{token}}",
  "type":"PERSON",
  "title":"Mr",
  "first_name":"Joanna",
  "middle_name":"Lewis",
  "last_name":"Adams",
  "category_identifier":{"name":"Contact Category"},
  "owned_by_group_identifier":{"name":"Main Group"},
  "privacy_level_identifier":{"number":"8"},
  "notes": "Family",
   "demographics":
   {
     "gender":"FEMALE",
     "id_number":"AB112234",
     "passport_number":"CD112234",
     "social_security_number":"EF112234",
     "country_of_residence_identifier":{"name":"CYPRUS"},
     "id_issued_by_country_identifier":{"name":"CYPRUS"},
     "passport_issued_by_country_identifier":{"name":"GREECE"},
     "industry_identifier":{"name":"Industry2"},
     "industry_sector_identifier":{"name":"FOREX"},
     "date_of_birth":{
                       "day":12,
                       "month":5,
                       "year":1981                    
                  },
     "name_day":     {
                       "day":18,
                       "month":8                    
                   }
   },
    "address_set": [
                     {
                       "type": "HOME",
                       "postal_code": "3020",
                       "street_name": "Ilia Papakiriakou",
                       "street_number" : "8",
                       "floor":2,
                       "apartment_number":"202",
                       "area": "Plati",
                       "town_city":"Aglanjia",
                       "district":"Nicosia",
                       "municipality":"Aglanjia",
                       "country_identifier":{ "two_character_code": "CY" },
                       "po_box":"70022",
                       "po_box_postal_code":"AG70022",
                       "care_of":"Maria Kyriacou",
                       "notes":"To be reviewed"
                       
             }
          ],
   "phone_set": [
                 {
                    "type": "LANDLINE",
                    "number":"22114455"
                 }
               ],
  "email_set": [
                 {
                    "type": "PERSONAL",
                    "email_address": "brianakozior@gmail.com"
                  }
                ],
  "fields_set":"first_name,last_name,demographics,email_set"
}

Response:

    {
    "status": {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data": {
        "last_name": "Adams",
        "first_name": "Joanna",
        "demographics": {
            "gender": "FEMALE",
            "passport_issued_by_country": {
                "three_character_code": "GRC",
                "two_character_code": "GR",
                "id": "209",
                "name": "GREECE",
                "alternative_code": null
            },
            "social_security_number": "EF112234",
            "passport_number": "CD112234",
            "industry_sector": {
                "id": "D8ACF18AB4494AD33738A9F4C94E6995",
                "name": "FOREX",
                "alternative_code": "FRX"
            },
            "country_of_residence": {
                "three_character_code": "CYP",
                "two_character_code": "CY",
                "id": "181",
                "name": "CYPRUS",
                "alternative_code": null
            },
            "name_day": {
                "month": 8,
                "day": 18
            },
            "date_of_birth": {
                "month": 5,
                "day": 12,
                "year": 1981
            },
            "id_number": "AB112234",
            "industry": {
                "id": "39E3A8C68925F4216D79C7EEBD71D4B4",
                "name": "Industry2",
                "code": "Ind2"
            },
            "id_issued_by_country": {
                "three_character_code": "CYP",
                "two_character_code": "CY",
                "id": "181",
                "name": "CYPRUS",
                "alternative_code": null
            }
        }
    }
}

POST contact_information/update

This method update a contact information. Single contact information can be updated by each call. Fields which are not specified are not updated at all. Fields which are specified as null will be set as null. All addresses, phones and emails which are added on the contact information are added as active

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

contact_information_identifier

(mandatory)

String

The identifier of the contact information to be updated. The allowed contact information identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the contact information

id_number

(semi-optional)

String

The ID number of the contact information

Applicable only for contact information that represent PERSON

passport_number

(semi-optional)

String

The passport number of the contact information

Applicable only for contact information that represent PERSON

social_security_number

(semi-optional)

String

The social security number of the contact information

Applicable only for contact information that represent PERSON

vat_registration_number

(semi-optional)

String

The VAT registration number of the contact information

Applicable only for contact information that represent COMPANY

registration_number

(semi-optional)

String

The registration number of the contact information

Applicable only for contact information that represent COMPANY

Available from CRM.COM R14.0.0

title

(optional)

String

The title of the contact information. Applicable only if the type is PERSON

first_name

(mandatory on conditions)

String

The first name of the contact information. Applicable and mandatory only if the type is PERSON

middle_name

(optional)

String

The middle name of the contact information. Applicable only if the type is PERSON

last_name

(mandatory on conditions)

String

The last name of the contact information. Applicable and mandatory only if the type is PERSON

company_name

(mandatory on conditions)

String

The company name of the contact information. Applicable and mandatory only if the type is COMPANY

category_identifier

(optional)

Identifier

The identifier of the contact category that will be associate with the contact information. The allowed contact category identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the contact category

name

(semi-optional)

String

The name of the category

code

(semi-optional)

String

The code of the category

owned_by_group_identifier

(optional)

Group identifier

The group owning the contact information. The allowed group identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the group

name

(semi-optional)

String

The code of the group

alternative_code

(semi-optional)

String

The alternative code of the group

privacy_level_identifier

(optional)

Privacy level identifier

The privacy level of the contact information. The allowed privacy level identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the privacy level

number

(semi-optional)

String

The number of the privacy level

notes

(optional)

String

Notes for the contact information

send_direct_marketing_material

(optional)

Boolean

The Contact Information's authorization setting for Direct Marketing

Available from CRM.COM R9.0.0

send_affiliate_marketing_material

(optional)

Boolean

The Contact Information's authorization setting for Affiliate Marketing

Available from CRM.COM R9.0.0

preferred_language

(optional)

String

The Contact Information's preferred language. The available options are:

ARA
DAN
ENG
EST
FIN
FRA
DEU
ELL
JPN
VIE
MAL
IND
TAI
LAV
LIT
NNO
POL
POR
RUS
SPA
SWE
UKR
CMN
TGL
HIN
CUSTOM1
CUSTOM2
CUSTOM3
CUSTOM4
CUSTOM5
CUSTOM6
CUSTOM7
CUSTOM8

Available from CRM.COM R12.0.0

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_float_5

(optional)

Float

User Defined Field of type Float

udf_float_6

(optional)

Float

User Defined Field of type Float

udf_float_7

(optional)

Float

User Defined Field of type Float

udf_float_8

(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

udf_date_5

(optional)

Date

User Defined Field of type Date

udf_date_6

(optional)

Date

User Defined Field of type Date

udf_date_7

(optional)

Date

User Defined Field of type Date

udf_date_8

(optional)

Date

User Defined Field of type Date

demographics

(optional)

Demographics object

The demographics of the contact information. Applicable only if the type is PERSON

company_profile

(optional)

Company profile object

The company profile of the contact information. Applicable only if the type is COMPANY

address_set

(optional)

Address object

The addresses of the contact information

If no records are specified in the set then nothing will be updated. To update a record use "action" : "update". To remove a record use "action" : "remove". To add a record use "action" : "add". Different actions can be used within the same set. For example:

"set": [
	   		{
            	"action": "update",
            	...........
        	},
			{
            	"action": "remove",
            	...........
			},
			{
            	"action": "add",
            	...........
			}
		]

phone_set

(optional)

Phone object

The phone of the contact information

If no records are specified in the set then nothing will be updated. To update a record use "action" : "update". To remove a record use "action" : "remove". To add a record use "action" : "add". Different actions can be used within the same set. For example:

"set": [
	   		{
            	"action": "update",
            	...........
        	},
			{
            	"action": "remove",
            	...........
			},
			{
            	"action": "add",
            	...........
			}
		]

email_set

(optional)

Email object

The email of the contact information

If no records are specified in the set then nothing will be updated. To update a record use "action" : "update". To remove a record use "action" : "remove". To add a record use "action" : "add". Different actions can be used within the same set. For example:

"set": [
	   		{
            	"action": "update",
            	...........
        	},
			{
            	"action": "remove",
            	...........
			},
			{
            	"action": "add",
            	...........
			}
		]

relation_set

(optional)

Contact Information business and personal relation object

The business and personal relations of the contact information

If no records are specified in the set then nothing will be updated. To update a record use "action" : "update". To remove a record use "action" : "remove". To add a record use "action" : "add". Different actions can be used within the same set. For example:

"set": [
	   		{
            	"action": "update",
            	...........
        	},
			{
            	"action": "remove",
            	...........
			},
			{
            	"action": "add",
            	...........
			}
		]

Available from CRM.COM R5.0.0

fields_set

(optional)

List of Strings, comma separated

A list of fields that should be included in the results. If not specified then all the available fields will be returned

Available from CRM.COM R10.0.0

Referred Parameter Objects Data

demographics parameter object data

Name

Type

Description

gender

(optional)

String

The gender of the contact information which can be MALE or FEMALE

id_number

(optional)

String

The ID number of the contact information

id_number_expiration_date

(optional)

Date

The expiration date of the ID number

Available from CRM.COM R14.0.0

passport_number

(optional)

String

The passport number of the contact information

passport_number_expiration_date

(optional)

Date

The expiration date of the passport

Available from CRM.COM R14.0.0

social_security_number

(optional)

String

The social security number of the contact information

country_of_residence_identifier

(optional)

Country identifier

The country of residence of the contact information. 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

id_issued_by_country_identifier

(optional)

Country identifier

The ID issued country of the contact information. 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

passport_issued_by_country_identifier

(optional)

Country identifier

The passport issued country of the contact information. 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

industry_identifier

(optional)

Industry identifier

The industry of the contact information. The allowed industry identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the industry

name

(semi-optional)

String

The name of the industry

code

(semi-optional)

String

The alternative code of the industry

industry_sector_identifier

(optional)

Industry Sector identifier

The sector of the contact information. The allowed industry sector identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the industry sector

name

(semi-optional)

String

The name of the industry sector

alternative_code

(semi-optional)

String

The alternative code of the industry sector

date_of_birth

(optional)

Date of Birth Object

The date of birth of the contact information

name_day

(optional)

Name Day Object

The name day of the contact information

Referred Parameter Objects Data

date_of_birth object parameter data

Name

Type

Description

day

(optional)

Integer

The day of the retrieved date of birth

month

(optional)

Integer

The month of the retrieved date of birth

year

(optional)

Integer

The year of the retrieved date of birth

name_day object parameter data

Name

Type

Description

day

(optional)

Integer

The day of the retrieved name day

month

(optional)

Integer

The month of the retrieved name day

company_profile parameter object data

Name

Type

Description

profile_year

(optional)

Number

The profile year of the contact information

annual_turnover

(optional)

Number

The annual turnover of the contact information

established_date

(optional)

Date

The established date of the contact information

number_of_employees

(optional)

Number

The number of employees of the contact information

registration_number

(optional)

String

The registration number of the contact information

vat_registration_number

(optional)

String

The vat registration number of the contact information

vat_registered_by

(optional)

String

The vat registration by of the contact information

vat_registration_date

(optional)

Date

The vat registration date of the contact information

tax_reference_number

(optional)

String

The tax reference number of the contact information

registered_in_country_identifier

Country Identifier

The country of registration of the contact information. 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

industry_identifier

(optional)

Industry identifier

The industry of the contact information. The allowed industry identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the industry

name

(semi-optional)

String

The name of the industry

code

(semi-optional)

String

The alternative code of the industry

industry_sector_identifier

(optional)

Industry Sector identifier

The sector of the contact information. The allowed industry sector identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the industry sector

name

(semi-optional)

String

The name of the industry sector

alternative_code

(semi-optional)

String

The alternative code of the industry sector

address parameter object data

From R14.2.0, the following parameters are applicable for CRM.COM Address Format

action

(mandatory)

String

Defines if a new or existing information will be updated.The supported values are the following:

ADD, UPDATE, REMOVE

address_identifier

(mandatory and applicable only on update or remove)

Address Identifier

The identifier of the contact information address to be updated. The supported address identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the address belonging to the specified contact information

type

(semi-optional)

String

The type of the address belonging to the specified contact information. The supported values are the following:

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

type

(mandatory and applicable only on add)

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)

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)

String

The municipality of the address

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

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

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 parameters are applicable for International Address Format

action

(mandatory)

String

Defines if a new or existing information will be updated.The supported values are the following:

ADD, UPDATE, REMOVE

address_identifier

(mandatory and applicable only on update or remove)

Address Identifier

The identifier of the contact information address to be updated. The supported address identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the address belonging to the specified contact information

type

(semi-optional)

String

The type of the address belonging to the specified contact information. The supported values are the following:

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

type

(mandatory and applicable only on add)

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:

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

address_line_1

(mandatory)

String

The address line 1

address_line_2

(optional)

String

The address line 2

state_province_county

(optional)

String

The state or province or county 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

phone parameter object data

Name

Type

Description

action

(mandatory)

String

Defines if a new or existing information will be updated.The supported values are the following:

ADD, UPDATE, REMOVE

phone_identifier

(mandatory and applicable only on update or remove)

Phone Identifier

The contact information phone to be updated. The supported phone identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the phone belonging to the specified contact information

type

(semi-optional)

String

The type of the phone which can be

LANDLINE, MOBILE, FAX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5

type

(mandatory and applicable only on add)

String

The type of the phone which can be

LANDLINE, MOBILE, FAX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5

number

(mandatory)

String

The number of the phone

area_code

(optional)

String

The area code of the phone

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

notes

(optional)

String

The notes of the phone

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_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

email parameter object data

Name

Type

Description

action

(mandatory)

String

Defines if a new or existing information will be updated.The supported values are the following:

ADD, UPDATE, REMOVE

email_identifier

(mandatory and applicable only on update or remove)

Email Identifier

The contact information email to be updated. The supported email identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the email belonging to the specified contact information

type

(semi-optional)

String

The type of the retrieved email which can be

PERSONAL, BUSINESS, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5

type

(mandatory and applicable only on add)

String

The type of the retrieved email which can be

PERSONAL, BUSINESS, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5

email_address

(mandatory)

String

The address of the retrieved email

notes

(optional)

String

The notes of the retrieved email

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_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

contact_information_relation parameter object data

Name

Type

Description

action

(mandatory)

String

Defines if a new or existing information will be updated.The supported values are the following:

ADD, UPDATE, REMOVE

relation_identifier

(mandatory and applicable only on update or remove)

Relation Identifier

The contact information business or personal relation to be updated. The supported contact information business or personal relation identifier fields are the following:

Name

Type

Description

id

(mandatory)

String

The ID of the contact information business or personal relation

type

(mandatory and applicable only on add. Optional on update)

String

The type of the contact information business or personal relation which can be one of the following:

FAMILY MEMBER, EXTENDED FAMILY, PARTNER, CLOSE FRIEND, FRIEND, WORK COLLEAGUE, PARTNER COMPANY, CLIENT, EMPLOYER, EMPLOYEE, BUSINESS, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5

contact_information

(mandatory and applicable only on add)

Contact Information Identifier

The related contact information. The allowed contact information identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the contact information

id_number

(semi-optional)

String

The ID number of the contact information

Applicable only for contact information that represent PERSON

passport_number

(semi-optional)

String

The passport number of the contact information

Applicable only for contact information that represent PERSON

social_security_number

(semi-optional)

String

The social security number of the contact information

Applicable only for contact information that represent PERSON

vat_registration_number

(semi-optional)

String

The VAT registration number of the contact information

Applicable only for contact information that represent COMPANY

registration_number

(semi-optional)

String

The registration number of the contact information

Applicable only for contact information that represent COMPANY

Available from CRM.COM R14.0.0

notes

(optional)

String

Notes for the contact information business or personal relation

Restrictions

It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Name	Type	Description
id	String	The ID of the retrieved contact information
type	String	The type of the retrieved contact information which can be PERSON or COMPANY
life_cycle_state	String	The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL
name	String	The full name of the retrieved contact information
title	String	The title of the retrieved contact information
first_name	String	The first name of the retrieved contact information
middle_name	String	The middle name of the retrieved contact information
last_name	String	The last name of the retrieved contact information
company_name	Sting	The company name of the retrieved contact information
notes	String	Notes for the contact information
organizational_unit	Integer	Indicates whether a contacts belongs to an organisational unit or not
preferred_language	String	The Contact Information's preferred language. The available values are: ARA DAN ENG EST FIN FRA DEU ELL JPN VIE MAL IND TAI LAV LIT NNO POL POR RUS SPA SWE UKR CMN TGL HIN CUSTOM1 CUSTOM2 CUSTOM3 CUSTOM4 CUSTOM5 CUSTOM6 CUSTOM7 CUSTOM8 Available from CRM.COM R12.0.0
udf_string_1	String	User Defined Field of type String
udf_string_2	String	User Defined Field of type String
udf_string_3	String	User Defined Field of type String
udf_string_4	String	User Defined Field of type String
udf_string_5	String	User Defined Field of type String
udf_string_6	String	User Defined Field of type String
udf_string_7	String	User Defined Field of type String
udf_string_8	String	User Defined Field of type String
udf_string_9	String	User Defined Field of type String
udf_string_10	String	User Defined Field of type String
udf_string_11	String	User Defined Field of type String
udf_string_12	String	User Defined Field of type String
udf_string_13	String	User Defined Field of type String
udf_string_14	String	User Defined Field of type String
udf_string_15	String	User Defined Field of type String
udf_string_16	String	User Defined Field of type String
udf_float_1	Float	User Defined Field of type Float
udf_float_2	Float	User Defined Field of type Float
udf_float_3	Float	User Defined Field of type Float
udf_float_4	Float	User Defined Field of type Float
udf_float_5	Float	User Defined Field of type Float
udf_float_6	Float	User Defined Field of type Float
udf_float_7	Float	User Defined Field of type Float
udf_float_8	Float	User Defined Field of type Float
udf_date_1	Date	User Defined Field of type Date
udf_date_2	Date	User Defined Field of type Date
udf_date_3	Date	User Defined Field of type Date
udf_date_4	Date	User Defined Field of type Date
udf_date_5	Date	User Defined Field of type Date
udf_date_6	Date	User Defined Field of type Date
udf_date_7	Date	User Defined Field of type Date
udf_date_8	Date	User Defined Field of type Date
kyc_profile	KYC profile object	The KYC profile information of the retrieved contact information Available from CRM.COM R14.0.0
demographics	Demographics object	The demographics of the retrieved contact information
company_profile	Company profile object	The company profile of the retrieved contact information
category	Category object	The category of the retrieved contact information
owned_by_group	Group object	The group that is owning the contact information Deprecated from CRM.COM R18.0.0 (replaced with owned_by_business_unit)
owned_by_business_unit	Business Unit Object	The business unit that is owning the contact information Available from CRM.COM R18.0.0
privacy_level	Privacy level object	The contact information's privacy level
log_information	Log Information Object	The log information related with the retrieved accounts receivable
addresses_set	Set of Contact information address Object	The addresses of the retrieved contact information
phones_set	Set of Contact information phone Object	The phones of the retrieved contact information
emails_set	Set of Contact information email Object	The emails of the retrieved contact information
relation_set	Set of Contact Information business and personal relation Objects	The business and personal relations of the retrieved contact information
authorization_settings	Contact Information Authorization settings object	The contact information's authorization settings information Available from CRM.COM R9.0.0
consent_information	Contact Consent Object	The contact information's consent information Available from CRM.COM R14.1.0

Referred Objects Response Data

kyc profile object response data

Name	Type	Description
kyc_profile_name	String	The KYC profile of the retrieved contact information
kyc_profile_expiration_date	Date	The KYC profile's expiration date
kyc_profile_state	String	The KYC profile's life cycle state. Available values are: PENDING_VERIFICATION, VERIFIED, REFUTE, EXPIRED

demographics object response data

Name	Type	Description
gender	String	The gender of the retrieved contact information which can be MALE or FEMALE
id_number	String	The ID number of the retrieved contact information
id_number_expiration_date	Date	The ID number's expiration date of the retrieved contact information Available from CRM.COM R14.0.0
passport_number	String	The passport number of the retrieved contact information
passport_number_expiration_date	Date	The passport's expiration date of the retrieved contact information Available from CRM.COM R14.0.0
social_security_number	String	The social security number of the retrieved contact information
date_of_birth	Date of Birth Object	The date of birth of the retrieved contact information
name_day	Name Day Object	The name day of the retrieved contact information
country_of_residence	Country Object	The country of residence of the retrieved contact information
id_issued_by_country	Country Object	The ID issued country of retrieved contact information
passport_issued_by_country	Country Object	The passport issued country of retrieved contact information
industry	Industry Object	The industry of retrieved contact information
industry_sector	Industry sector Object	The sector of retrieved contact information

Referred Objects Response Data

date_of_birth object response data

Name	Type	Description
day	Integer	The day of the retrieved date of birth
month	Integer	The month of the retrieved date of birth
year	Integer	The year of the retrieved date of birth

name_day object response data

Name	Type	Description
day	Integer	The day of the retrieved name day
month	Integer	The month of the retrieved name day

country object response data

Name	Type	Description
id	String	The id of the retrieved country
name	String	The name of the retrieved country
alternative_code	String	The alternative code of the retrieved country
dialing_code	String	The dialing code of the retrieved country Available from CRM.COM R15.1.0
two_character_code	String	The two character code of the retrieved country
three_character_code	String	The three character code of the retrieved country
country_flag	Image Object	The flag of the retrieved country Available from CRM.COM R15.1.0

Referred Objects Response Data

country_flag object response data

Name	Type	Description
id	String	The ID of the retrieved country flag
file	File Object	The information of the attached file

Referred Objects Response Data

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

industry object response data

Name	Type	Description
id	String	The id of the retrieved industry
name	String	The name of the retrieved industry
code	String	The code of the retrieved industry

industry sector object response data

Name	Type	Description
id	String	The id of the retrieved industry sector
name	String	The name of the retrieved industry sector
alternative_code	String	The alternative code of the retrieved industry sector

company profile object response data

Name	Type	Description
profile_year	Number	The profile year of the retrieved contact information
annual_turnover	Number	The annual turnover of the retrieved contact information
established_date	Date	The established date of the retrieved contact information
number_of_employees	Number	The number of employees of the retrieved contact information
registration_number	String	The registration number of the retrieved contact information
vat_registration_number	String	The vat registration number of the retrieved contact information
vat_registered_by	String	The vat registration by of the retrieved contact information
vat_registration_date	Date	The vat registration date of the retrieved contact information
tax_reference_number	String	The tax referenece number of the retrieved contact information
registered_in_country	Country Object	The country of residence of the retrieved contact information
industry	Industry Object	The industry of retrieved contact information
industry_sector	Industry sector Object	The sector of retrieved contact information

Referred Objects Response Data

country object response data

Name	Type	Description
id	String	The id of the retrieved country
name	String	The name of the retrieved country
alternative_code	String	The alternative code of the retrieved country
dialing_code	String	The dialing code of the retrieved country Available from CRM.COM R15.1.0
two_character_code	String	The two character code of the retrieved country
three_character_code	String	The three character code of the retrieved country
country_flag	Image Object	The flag of the retrieved country Available from CRM.COM R15.1.0

Referred Objects Response Data

country_flag object response data

Name	Type	Description
id	String	The ID of the retrieved country flag
file	File Object	The information of the attached file

Referred Objects Response Data

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

industry object response data

Name	Type	Description
id	String	The id of the retrieved industry
name	String	The name of the retrieved industry
code	String	The code of the retrieved industry

industry sector object response data

Name	Type	Description
id	String	The id of the retrieved industry sector
name	String	The name of the retrieved industry sector
alternative_code	String	The alternative code of the retrieved industry sector

contact category object response data

Name	Type	Description
id	String	The id of the retrieved category
name	String	The name of the retrieved category
code	String	The code of the retrieved category

group object response data

Name	Type	Description
id	String	The ID of the retrieved group
name	String	The name of the retrieved group
community_name	String	The name of the community that the retrieved group belongs to
alternative_code	String	The alternative code of the retrieved group
unified_code	String	The unified code of the retrieved group Available from CRM.COM R16.2.2
description	String	The description of the retrieved group

business unit object response data

Name	Type	Description
id	String	The ID of the retrieved business unit
name	String	The name of the retrieved business unit
code	String	The code of the retrieved business unit
unified_code	String	The unified code of the retrieved business unit
description	String	The description of the retrieved business unit
parent_business_unit_name	String	The name of the parent business unit that the retrieved business unit belongs to

privacy_level object response data

Name	Type	Description
id	String	The id of the retrieved privacy level
number	String	The number of the retrieved privacy level
name	String	The name of the retrieved privacy level
hierarchy_level	String	The hierarchy level of the retrieved privacy level

log_information object response data

Name	Type	Description
created_date	Date	The date that the retrieved record was created
updated_date	Date	The last date that the retrieved record was updated
created_by_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
created_by_business_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Available from CRM.COM R18.0.0
created_by_user	User Object	The user that created the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled
updated_by_unit	Unit Object	The last unit that updated the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
updated_by_business_unit	Unit Object	The last unit that updated the retrieved record Available from CRM.COM R18.0.0
updated_by_user	User Object	The last user that updated the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

Referred Objects Response Data

unit object response data

Name	Type	Description
id	String	The ID of the retrieved unit
name	String	The name of the retrieved unit
group_name	String	The name of the group that the retrieved unit belongs to
community_name	String	The name of the community that the retrieved unit belongs to
alternative_code	String	The alternative code of the retrieved unit
description	String	The description of the retrieved unit

business unit object response data

Name	Type	Description
id	String	The ID of the retrieved business unit
name	String	The name of the retrieved business unit
code	String	The code of the retrieved business unit
unified_code	String	The unified code of the retrieved business unit
description	String	The description of the retrieved business unit
parent_business_unit_name	String	The name of the parent business unit that the retrieved business unit belongs to

user object response data

Name	Type	Description
id	String	The ID of the retrieved user
username	String	The user name of the retrieved user
person_name	String	The full name of the retrieved user
email	String	The email of the retrieved user

address object response data

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

Name	Type	Description
id	String	The ID of the retrieved address
type	String	The type of the retrieved address which can be HOME, BUSINESS, POBOX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5
postal_code	String	The postal code of the retrieved address
street_name	String	The street name of the retrieved address
street_number	String	The street number of the retrieved address
floor	Integer	The floor of the retrieved address
apartment_number	String	The apartment number of the retrieved address
area	String	The area of the retrieved address
town_city	String	The town / city of the retrieved address
district	String	The district of the retrieved address
municipality	String	The municipality of the retrieved address
po_box	String	The PO box of the retrieved address
po_box_postal_code	String	The PO box postal code of the retrieved address
care_of	String	The care of person of the retrieved address
udf_string_1	String	User Defined Field of type String
udf_string_2	String	User Defined Field of type String
udf_string_3	String	User Defined Field of type String
udf_string_4	String	User Defined Field of type String
udf_string_5	String	User Defined Field of type String
udf_string_6	String	User Defined Field of type String
udf_string_7	String	User Defined Field of type String
udf_string_8	String	User Defined Field of type String
udf_string_9	String	User Defined Field of type String
udf_string_10	String	User Defined Field of type String
udf_string_11	String	User Defined Field of type String
udf_string_12	String	User Defined Field of type String
udf_string_13	String	User Defined Field of type String
udf_string_14	String	User Defined Field of type String
udf_string_15	String	User Defined Field of type String
udf_string_16	String	User Defined Field of type String
udf_float_1	Float	User Defined Field of type Float
udf_float_2	Float	User Defined Field of type Float
udf_float_3	Float	User Defined Field of type Float
udf_float_4	Float	User Defined Field of type Float
udf_date_1	Date	User Defined Field of type Date
udf_date_2	Date	User Defined Field of type Date
udf_date_3	Date	User Defined Field of type Date
udf_date_4	Date	User Defined Field of type Date
country	Country Object	The country of the retrieved address
is_primary	Boolean	Defines if the address is the contact's primary address or not. Available from CRM.COM R15

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

Name	Type	Description
id	String	The ID of the retrieved address
type	String	The type of the retrieved address which can be HOME, BUSINESS, POBOX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5
postal_code	String	The postal code of the retrieved address
town_city	String	The town / city of the retrieved address
address_line_1	String	The address line 1
address_line_2	String	The address line 2
state_province_county	String	The state or province or county of the address.
udf_string_1	String	User Defined Field of type String
udf_string_2	String	User Defined Field of type String
udf_string_3	String	User Defined Field of type String
udf_string_4	String	User Defined Field of type String
udf_string_5	String	User Defined Field of type String
udf_string_6	String	User Defined Field of type String
udf_string_7	String	User Defined Field of type String
udf_string_8	String	User Defined Field of type String
udf_string_9	String	User Defined Field of type String
udf_string_10	String	User Defined Field of type String
udf_string_11	String	User Defined Field of type String
udf_string_12	String	User Defined Field of type String
udf_string_13	String	User Defined Field of type String
udf_string_14	String	User Defined Field of type String
udf_string_15	String	User Defined Field of type String
udf_string_16	String	User Defined Field of type String
udf_float_1	Float	User Defined Field of type Float
udf_float_2	Float	User Defined Field of type Float
udf_float_3	Float	User Defined Field of type Float
udf_float_4	Float	User Defined Field of type Float
udf_date_1	Date	User Defined Field of type Date
udf_date_2	Date	User Defined Field of type Date
udf_date_3	Date	User Defined Field of type Date
udf_date_4	Date	User Defined Field of type Date
country	Country Object	The country of the retrieved address
is_primary	Boolean	Defines if the address is the contact's primary address or not. Available from CRM.COM R15

Referred Objects Response Data

country object response data

Name	Type	Description
id	String	The id of the retrieved country
name	String	The name of the retrieved country
alternative_code	String	The alternative code of the retrieved country
dialing_code	String	The dialing code of the retrieved country Available from CRM.COM R15.1.0
two_character_code	String	The two character code of the retrieved country
three_character_code	String	The three character code of the retrieved country
country_flag	Image Object	The flag of the retrieved country Available from CRM.COM R15.1.0

Referred Objects Response Data

country_flag object response data

Name	Type	Description
id	String	The ID of the retrieved country flag
file	File Object	The information of the attached file

Referred Objects Response Data

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

phone object response data

Name	Type	Description
id	String	The ID of the retrieved phone
type	String	The type of the retrieved phone which can be LANDLINE, MOBILE, FAX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5
number	String	The number of the retrieved phone
area_code	String	The area code of the retrieved phone
full_number	String	The full number of the retrieved phone
notes	String	The notes of the retrieved phone
udf_string_1	String	User Defined Field of type String
udf_string_2	String	User Defined Field of type String
udf_string_3	String	User Defined Field of type String
udf_string_4	String	User Defined Field of type String
udf_string_5	String	User Defined Field of type String
udf_string_6	String	User Defined Field of type String
udf_string_7	String	User Defined Field of type String
udf_string_8	String	User Defined Field of type String
udf_float_1	Float	User Defined Field of type Float
udf_float_2	Float	User Defined Field of type Float
udf_float_3	Float	User Defined Field of type Float
udf_float_4	Float	User Defined Field of type Float
udf_date_1	Date	User Defined Field of type Date
udf_date_2	Date	User Defined Field of type Date
udf_date_3	Date	User Defined Field of type Date
udf_date_4	Date	User Defined Field of type Date
country	Country Object	The country of the retrieved phone
is_primary	Boolean	Defines if the phone is the contact's primary phone or not. Available from CRM.COM R15

Referred Objects Response Data

country object response data

Name	Type	Description
id	String	The id of the retrieved country
name	String	The name of the retrieved country
alternative_code	String	The alternative code of the retrieved country
dialing_code	String	The dialing code of the retrieved country Available from CRM.COM R15.1.0
two_character_code	String	The two character code of the retrieved country
three_character_code	String	The three character code of the retrieved country
country_flag	Image Object	The flag of the retrieved country Available from CRM.COM R15.1.0

Referred Objects Response Data

country_flag object response data

Name	Type	Description
id	String	The ID of the retrieved country flag
file	File Object	The information of the attached file

Referred Objects Response Data

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

email object response data

Name	Type	Description
id	String	The ID of the retrieved email
type	String	The type of the retrieved email which can be PERSONAL, BUSINESS, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5
email_address	String	The address of the retrieved email
notes	String	The notes of the retrieved email
udf_string_1	String	User Defined Field of type String
udf_string_2	String	User Defined Field of type String
udf_string_3	String	User Defined Field of type String
udf_string_4	String	User Defined Field of type String
udf_string_5	String	User Defined Field of type String
udf_string_6	String	User Defined Field of type String
udf_string_7	String	User Defined Field of type String
udf_string_8	String	User Defined Field of type String
udf_float_1	Float	User Defined Field of type Float
udf_float_2	Float	User Defined Field of type Float
udf_float_3	Float	User Defined Field of type Float
udf_float_4	Float	User Defined Field of type Float
udf_date_1	Date	User Defined Field of type Date
udf_date_2	Date	User Defined Field of type Date
udf_date_3	Date	User Defined Field of type Date
udf_date_4	Date	User Defined Field of type Date
is_primary	Boolean	Defines if the email is the contact's primary email or not. Available from CRM.COM R15

contact_information_relation object response data

Name	Type	Description
id	String	The ID of the retrieved contact information business or personal relation
type	String	The type of the retrieved contact information business or personal relation which can be FAMILY MEMBER, EXTENDED FAMILY, PARTNER, CLOSE FRIEND, FRIEND, WORK COLLEAGUE, PARTNER COMPANY, CLIENT, EMPLOYER, EMPLOYEE, BUSINESS, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5
relation_type	String	The relation type of the retrieved contact information The supported values are INWARD, OUTWARD Available from CRM.COM R14.2.0 Deprecated from CRM.COM R17
notes	String	The notes of the retrieved contact information business or personal relation
contact_information	Contact Information Object	The related contact information

Referred Response Objects Data

contact_information object response data

Name	Type	Description
id	String	The ID of the retrieved contact information
type	String	The type of the retrieved contact information which can be PERSON or COMPANY
life_cycle_state	String	The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL
name	String	The full name of the retrieved contact information
first_name	String	The first name of the retrieved contact information
middle_name	String	The middle name of the retrieved contact information
last_name	String	The last name of the retrieved contact information
title	String	The title of the retrieved contact information
company_name	Sting	The company name of the retrieved contact information
demographics	Demographics Object	The demographics information of the retrieved contact information
company_profile	Company profile object	The company profile of the retrieve contact information

Referred Objects Response Data

demographics object response data

Name	Type	Description
gender	String	The gender of the retrieved contact information which can be MALE or FEMALE
id_number	String	The ID number of the retrieved contact information
id_number_expiration_date	Date	The ID number's expiration date of the retrieved contact information Available from CRM.COM R14.0.0
passport_number	String	The passport number of the retrieved contact information
passport_number_expiration_date	Date	The passport's expiration date of the retrieved contact information Available from CRM.COM R14.0.0
social_security_number	String	The social security number of the retrieved contact information
date_of_birth	Date of Birth Object	The date of birth of the retrieved contact information
name_day	Name Day Object	The name day of the retrieved contact information
country_of_residence	Country Object	The country of residence of the retrieved contact information
id_issued_by_country	Country Object	The ID issued country of retrieved contact information
passport_issued_by_country	Country Object	The passport issued country of retrieved contact information
industry	Industry Object	The industry of retrieved contact information
industry_sector	Industry sector Object	The sector of retrieved contact information

Referred Objects Response Data

date_of_birth object response data

Name	Type	Description
day	Integer	The day of the retrieved date of birth
month	Integer	The month of the retrieved date of birth
year	Integer	The year of the retrieved date of birth

name_day object response data

Name	Type	Description
day	Integer	The day of the retrieved name day
month	Integer	The month of the retrieved name day

country object response data

Name	Type	Description
id	String	The id of the retrieved country
name	String	The name of the retrieved country
alternative_code	String	The alternative code of the retrieved country
dialing_code	String	The dialing code of the retrieved country Available from CRM.COM R15.1.0
two_character_code	String	The two character code of the retrieved country
three_character_code	String	The three character code of the retrieved country
country_flag	Image Object	The flag of the retrieved country Available from CRM.COM R15.1.0

Referred Objects Response Data

country_flag object response data

Name	Type	Description
id	String	The ID of the retrieved country flag
file	File Object	The information of the attached file

Referred Objects Response Data

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

industry object response data

Name	Type	Description
id	String	The id of the retrieved industry
name	String	The name of the retrieved industry
code	String	The code of the retrieved industry

industry sector object response data

Name	Type	Description
id	String	The id of the retrieved industry sector
name	String	The name of the retrieved industry sector
alternative_code	String	The alternative code of the retrieved industry sector

company profile object response data

Name	Type	Description
profile_year	Number	The profile year of the retrieved contact information
annual_turnover	Number	The annual turnover of the retrieved contact information
established_date	Date	The established date of the retrieved contact information
number_of_employees	Number	The number of employees of the retrieved contact information
registration_number	String	The registration number of the retrieved contact information
vat_registration_number	String	The vat registration number of the retrieved contact information
vat_registered_by	String	The vat registration by of the retrieved contact information
vat_registration_date	Date	The vat registration date of the retrieved contact information
tax_reference_number	String	The tax referenece number of the retrieved contact information
registered_in_country	Country Object	The country of residence of the retrieved contact information
industry	Industry Object	The industry of retrieved contact information
industry_sector	Industry sector Object	The sector of retrieved contact information

Referred Objects Response Data

country object response data

Name	Type	Description
id	String	The id of the retrieved country
name	String	The name of the retrieved country
alternative_code	String	The alternative code of the retrieved country
dialing_code	String	The dialing code of the retrieved country Available from CRM.COM R15.1.0
two_character_code	String	The two character code of the retrieved country
three_character_code	String	The three character code of the retrieved country
country_flag	Image Object	The flag of the retrieved country Available from CRM.COM R15.1.0

Referred Objects Response Data

country_flag object response data

Name	Type	Description
id	String	The ID of the retrieved country flag
file	File Object	The information of the attached file

Referred Objects Response Data

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

industry object response data

Name	Type	Description
id	String	The id of the retrieved industry
name	String	The name of the retrieved industry
code	String	The code of the retrieved industry

industry sector object response data

Name	Type	Description
id	String	The id of the retrieved industry sector
name	String	The name of the retrieved industry sector
alternative_code	String	The alternative code of the retrieved industry sector

contact_information_authorization object response data

Name	Type	Description
send_direct_ marketing_material	Boolean	Defines whether the contact wants to be contacted for Direct Marketing purposes
direct_marketing_setting_updated_date	Date	The last date that the contact information's authorization setting for Direct Marketing was updated
send_affiliate_ marketing_material	Boolean	Defines whether the contact wants to be contacted for Affiliate Marketing purposes
affiliate_marketing_setting_updated_date	Date	The last date that the contact information's authorization setting for Affiliate Marketing was updated
direct_marketing_setting_updated_by_user	User Object	The name of the last user that updated the contact information's authorization setting for Affiliate Marketing
affiliated_marketing_setting_updated_by_user	User Object	The name of the last user that updated the contact information's authorization setting for Affiliate Marketing

Referred Objects Response Data

user object response data

Name	Type	Description
id	String	The ID of the retrieved user
username	String	The user name of the retrieved user
person_name	String	The full name of the retrieved user
email	String	The email of the retrieved user

contact consent object response data

Name	Type	Description
id	String	The ID of the retrieved contact information
contact_consent_state	String	The state of the Contact's Consent. Applicable values are: PENDING ACCEPTED REJECTED WITHDRAWN
contact_consent_updated_date	Date	The updated date of the Contact's Consent
contact_consent_form	Attachments Object	The Contact's accepted Consent Form. Applicable only if Consent State is ACCEPTED

Referred Objects Response Data

Attachments object response data

Name	Type	Description
id	String	The ID of the retrieved attachment
entity	String	The name of the entity related with the attachment. The supported entities are the following: ACCOUNTSRECEIVABLE ACTIVITIES COMMUNICATIONS COMMUNICATIONTEMPLATES CONTACTINFORMATION INSTALLEDITEMS JOBS LEADS PRODUCTS SERVICEREQUESTS ATTACHMENTSLIBRARY From CRM.COM R12.2.0, ATTACHMENTSLIBRARY is available From CRM.COM R14.0.0, COMMUNICATIONTEMPLATES is available
entity_id	String	The ID of the entity related with the attachment.
url	String	The attached URL. This information is empty if the attachment is a file.
notes	String	The comments related with the retrieved attachment
classification	Attachments Classification Object	The classification of the attachment Available from CRM.COM R12.2.0
file	File Object	The information of the attached file. This information is empty if the attachment is a URL.
log_information	Log Information Object	The log information of the retrieved attachment

Referred Objects Response Data

classification object response data

Name	Type	Description
id	String	The id of the retrieved attachment classification
name	String	The name of the retrieved attachment classification
alternative_code	String	The alternative code of the retrieved attachment classification

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

log_information object response data

Name	Type	Description
created_date	Date	The date that the retrieved record was created
updated_date	Date	The last date that the retrieved record was updated
created_by_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
created_by_business_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Available from CRM.COM R18.0.0
created_by_user	User Object	The user that created the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled
updated_by_unit	Unit Object	The last unit that updated the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
updated_by_business_unit	Unit Object	The last unit that updated the retrieved record Available from CRM.COM R18.0.0
updated_by_user	User Object	The last user that updated the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

Referred Objects Response Data

unit object response data

Name	Type	Description
id	String	The ID of the retrieved unit
name	String	The name of the retrieved unit
group_name	String	The name of the group that the retrieved unit belongs to
community_name	String	The name of the community that the retrieved unit belongs to
alternative_code	String	The alternative code of the retrieved unit
description	String	The description of the retrieved unit

business unit object response data

Name	Type	Description
id	String	The ID of the retrieved business unit
name	String	The name of the retrieved business unit
code	String	The code of the retrieved business unit
unified_code	String	The unified code of the retrieved business unit
description	String	The description of the retrieved business unit
parent_business_unit_name	String	The name of the parent business unit that the retrieved business unit belongs to

user object response data

Name	Type	Description
id	String	The ID of the retrieved user
username	String	The user name of the retrieved user
person_name	String	The full name of the retrieved user
email	String	The email of the retrieved user

Examples

Example 1

HTTP Method: POST

Request:

Body:

{
"token":"{{token}}",
"contact_information_identifier":{"id":"3459F30F71E7477495DF3AA3D278CC7D"},
"type ":"PERSON",
"address_set":
    [{
            "action":"add",
            "type":"BUSINESS",
            "postal_code":"7060",
            "street_name":"Latisa",
            "street_number":"12",
            "floor":2,
            "apartment_number":"204",
            "area":"Latsia",
            "town_city":"Nicosia",
            "district":"Nicosia",
            "municipality":"NA Nicosia",
            "country_identifier":{"id":"181"},
            "po_box":"986547",
            "po_box_postal_code":"986547-1"
        }],
"phone_set":
    [{
    "action": "update",
    "phone_identifier":{"type":"LANDLINE"},
    "number":"99849996",
    "country_identifier":{"id":"180"}
    }],
"send_direct_marketing_material":0,
"send_affiliate_marketing_material":0
}

Response:

{
  "data": {
    "notes": null,
    "log_information": {
      "created_by_unit": {
        "alternative_code": "adminunit",
        "group_name": "Main Group",
        "community_name": "Community",
        "name": "Admin Unit",
        "description": "admin unit",
        "id": "1"
      },
      "updated_by_unit": {
        "alternative_code": "adminunit",
        "group_name": "Main Group",
        "community_name": "Community",
        "name": "Admin Unit",
        "description": "admin unit",
        "id": "1"
      },
      "created_date": "2016-08-10T09:18:32",
      "updated_date": "2016-08-10T09:32:08",
      "updated_by_user": {
        "person_name": "CRM COM",
        "id": "1",
        "username": "MPAdministrator"
      },
      "created_by_user": {
        "person_name": "MPAdministrator",
        "id": "1",
        "email": "dev@crm.com",
        "username": "MPAdministrator"
      }
    },
    "type": "PERSON",
    "id": "3459F30F71E7477495DF3AA3D278CC7D",
    "organizational_unit": 0,
    "udf_string_2": null,
    "udf_string_3": null,
    "udf_string_4": null,
    "udf_string_5": null,
    "privacy_level": null,
    "udf_string_1": null,
    "life_cycle_state": "MARKETING",
    "phones_set": [
      {
        "udf_string_2": null,
        "udf_string_3": null,
        "country": {
          "alternative_code": "CUB",
          "three_character_code": null,
          "name": "CUBA",
          "id": "180",
          "two_character_code": null
        },
        "udf_string_4": null,
        "notes": null,
        "udf_string_5": null,
        "area_code": "53",
        "udf_string_1": null,
        "type": "LANDLINE",
        "udf_date_2": null,
        "udf_date_1": null,
        "udf_date_4": null,
        "full_number": "005399849996",
        "udf_date_3": null,
        "number": "99849996",
        "udf_float_3": null,
        "udf_float_4": null,
        "id": "49D7EC23AE92455492A7F9D5BC2EB887",
        "state": "Active",
        "udf_string_6": null,
        "udf_float_1": null,
        "udf_string_7": null,
        "udf_float_2": null,
        "udf_string_8": null
      }
    ],
    "company_name": null,
    "name": "Ellen Leon",
    "udf_string_6": null,
    "udf_string_7": null,
    "udf_string_8": null,
    "udf_string_9": null,
    "relation_set": [],
    "addresses_set": [
      {
        "apartment_number": "2",
        "care_of": null,
        "country": {
          "alternative_code": "CYP",
          "three_character_code": "CYP",
          "name": "CYPRUS",
          "id": "181",
          "two_character_code": "CY"
        },
        "municipality": null,
        "type": "HOME",
        "udf_date_2": null,
        "udf_date_1": null,
        "street_name": "Piccadilly Avenue",
        "udf_date_4": null,
        "udf_date_3": null,
        "udf_float_3": null,
        "udf_float_4": null,
        "po_box_postal_code": null,
        "udf_string_15": null,
        "udf_string_16": null,
        "udf_string_13": null,
        "udf_string_14": null,
        "udf_string_11": null,
        "udf_string_12": null,
        "id": "548EDA85AED54AD1A64D362C28046157",
        "state": "Active",
        "udf_string_10": null,
        "floor": 5,
        "udf_float_1": null,
        "udf_float_2": null,
        "area": null,
        "udf_string_2": null,
        "udf_string_3": null,
        "udf_string_4": null,
        "udf_string_5": null,
        "udf_string_1": null,
        "po_box": null,
        "town_city": "Oxford",
        "district": null,
        "street_number": "21",
        "postal_code": "bas321",
        "udf_string_6": null,
        "udf_string_7": null,
        "udf_string_8": null,
        "udf_string_9": null
      },
      {
        "apartment_number": "204",
        "care_of": null,
        "country": {
          "alternative_code": "CYP",
          "three_character_code": "CYP",
          "name": "CYPRUS",
          "id": "181",
          "two_character_code": "CY"
        },
        "municipality": "NA Nicosia",
        "type": "BUSINESS",
        "udf_date_2": null,
        "udf_date_1": null,
        "street_name": "Latisa",
        "udf_date_4": null,
        "udf_date_3": null,
        "udf_float_3": null,
        "udf_float_4": null,
        "po_box_postal_code": "986547-1",
        "udf_string_15": null,
        "udf_string_16": null,
        "udf_string_13": null,
        "udf_string_14": null,
        "udf_string_11": null,
        "udf_string_12": null,
        "id": "52012022FE1E464D935DFC2585987216",
        "state": "Active",
        "udf_string_10": null,
        "floor": 2,
        "udf_float_1": null,
        "udf_float_2": null,
        "area": "Latsia",
        "udf_string_2": null,
        "udf_string_3": null,
        "udf_string_4": null,
        "udf_string_5": null,
        "udf_string_1": null,
        "po_box": "986547",
        "town_city": "Nicosia",
        "district": "Nicosia",
        "street_number": "12",
        "postal_code": "7060",
        "udf_string_6": null,
        "udf_string_7": null,
        "udf_string_8": null,
        "udf_string_9": null
      }
    ],
    "owned_by_group": {
      "alternative_code": "MG",
      "community_name": "Community",
      "name": "Main Group",
      "description": "Main Group",
      "id": "1"
    },
    "udf_date_6": null,
    "udf_date_5": null,
    "udf_date_8": null,
    "udf_date_7": null,
    "title": "Miss",
    "udf_date_2": null,
    "udf_date_1": null,
    "udf_date_4": null,
    "udf_date_3": null,
    "emails_set": [],
    "udf_float_5": null,
    "udf_float_6": null,
    "udf_float_3": null,
    "udf_float_4": null,
    "company_profile": {
      "tax_reference_number": null,
      "registered_in_country": null,
      "number_of_employees": null,
      "annual_turnover": null,
      "profile_year": null,
      "registration_number": null,
      "vat_registration_number": null,
      "industry_sector": null,
      "industry": null,
      "established_date": null,
      "vat_registered_by": null,
      "vat_registration_date": null
    },
    "udf_string_15": null,
    "udf_string_16": null,
    "udf_string_13": null,
    "udf_float_7": null,
    "udf_string_14": null,
    "udf_float_8": null,
    "udf_string_11": null,
    "udf_string_12": null,
    "udf_string_10": null,
    "udf_float_1": null,
    "first_name": "Ellen",
    "udf_float_2": null,
    "last_name": "Leon",
    "middle_name": "Arthour",
    "authorization_settings": {
      "direct_marketing_setting_updated_by_user": {
        "person_name": "CRM COM",
        "id": "1",
        "username": "MPAdministrator"
      },
      "affiliate_marketing_setting_updated_by_user": {
        "person_name": "CRM COM",
        "id": "1",
        "username": "MPAdministrator"
      },
      "affiliate_marketing_setting_updated_date": "2016-08-10T09:32:08",
      "send_affiliate_marketing_material": false,
      "send_direct_marketing_material": false,
      "direct_marketing_setting_updated_date": "2016-08-10T09:32:08"
    },
    "category": null,
    "demographics": {
      "name_day": {
        "month": null,
        "day": null
      },
      "id_number": "ADASF125546665",
      "gender": "FEMALE",
      "country_of_residence": {
        "alternative_code": "CYP",
        "three_character_code": "CYP",
        "name": "CYPRUS",
        "id": "181",
        "two_character_code": "CY"
      },
      "date_of_birth": {
        "month": null,
        "year": null,
        "day": null
      },
      "industry_sector": null,
      "passport_number": "DDFF12336544",
      "industry": null,
      "social_security_number": "54561465146",
      "id_issued_by_country": {
        "alternative_code": "GBR",
        "three_character_code": null,
        "name": "UNITED KINGDOM",
        "id": "126",
        "two_character_code": null
      },
      "passport_issued_by_country": {
        "alternative_code": "GBR",
        "three_character_code": null,
        "name": "UNITED KINGDOM",
        "id": "126",
        "two_character_code": null
      }
    }
  },
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}

GET contact_information/profile_photo/view

Available from CRM.COM R11.0.0

This method returns the profile photo information related with a contact information

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

contact_information_identifier

(mandatory)

Identifier

The identifier of the contact information that should be retrieved. The allowed contact information identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the contact information

id_number

(semi-optional)

String

The ID number of the contact information

Applicable only for contact information that represent PERSON

passport_number

(semi-optional)

String

The passport number of the contact information

Applicable only for contact information that represent PERSON

social_security_number

(semi-optional)

String

The social security number of the contact information

Applicable only for contact information that represent PERSON

vat_registration_number

(semi-optional)

String

The VAT registration number of the contact information

Applicable only for contact information that represent COMPANY

registration_number

(semi-optional)

String

The registration number of the contact information

Applicable only for contact information that represent COMPANY

Available from CRM.COM R14.0.0

fields_set
(optional)

List of Strings, comma separated

A list of fields that should be included in the results. If not specified then all the available fields will be returned

Restrictions

It is mandatory to specify at least one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

Examples

Example 1

HTTP Method: GET

Request:

Response:

 {
  "data": {
    "file_name": "217F456047A749728A263BEC2A472003_key_contacts-profilephoto_images.jpg",
    "file_content_url": "/crm/ImageDownloadServlet?id=217F456047A749728A263BEC2A472003",
    "file_mime_type": "image/jpeg"
  },
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}

Note:

To retrieve or display the actual image you need to construct the following URL

{{server}}{{file_content_url}}&token={{token}}

for example

https://r11qa.crm.com/crm/ImageDownloadServlet?id=217F456047A749728A263BEC2A472003&token=B18ECEE5918442A0A29B7C1B2D0A4260

POST contact_information/profile_photo/add

Available from CRM.COM R11.0.0

This method is used to add a profile photo on an existing contact information. This Web API method requires a multipart/form-data post, as defined in RFC 1867. There are many libraries available that can be used in order to submit multipart/form-data posts (for example MultipartEntity in Java). A single contact information can be updated through each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

contact_information_identifier

(mandatory)

Identifier

The identifier of the contact information that should be updated. The allowed contact information identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the contact information

id_number

(semi-optional)

String

The ID number of the contact information

Applicable only for contact information that represent PERSON

passport_number

(semi-optional)

String

The passport number of the contact information

Applicable only for contact information that represent PERSON

social_security_number

(semi-optional)

String

The social security number of the contact information

Applicable only for contact information that represent PERSON

vat_registration_number

(semi-optional)

String

The VAT registration number of the contact information

Applicable only for contact information that represent COMPANY

registration_number

(semi-optional)

String

The registration number of the contact information

Applicable only for contact information that represent COMPANY

Available from CRM.COM R14.0.0

file

(semi-optional)

File

The file that should be added as a profile picture

fields_set
(optional)

List of Strings, comma separated

A list of fields that should be included in the results. If not specified then all the available fields will be returned

Restrictions

It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

Examples

Example 1

cURL Example:

curl --request POST \
  --url https://r11qa.crm.com/crmapi/rest/v2/contact_information/profile_photo/add \
  --header 'content-type: multipart/form-data; boundary=---011000010111000001101001' \
  --form 'file=@[object Object]' \
  --form contact_information_identifier=id=18686813304341ECAFC8175A85594C9B \
  --form 'token=C9464BFEC45F49989AAB17E1C54FA4D0'

PHP Example:

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://r11qa.crm.com/crmapi/rest/v2/contact_information/profile_photo/add",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"[object Object]\"\r\nContent-Type: false\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contact_information_identifier\"\r\n\r\nid=18686813304341ECAFC8175A85594C9B\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"token\"\r\n\r\nC9464BFEC45F49989AAB17E1C54FA4D0\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => array(
    "content-type: multipart/form-data; boundary=---011000010111000001101001"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

POST contact_information/profile_photo/remove

Available from CRM.COM R11.0.0

This method is used to remove the profile photo from a specific contact information. A single contact information can be updated through this method

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

contact_information_identifier

(mandatory)

Identifier

The identifier of the contact information that should be updated. The allowed contact information identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the contact information

id_number

(semi-optional)

String

The ID number of the contact information

Applicable only for contact information that represent PERSON

passport_number

(semi-optional)

String

The passport number of the contact information

Applicable only for contact information that represent PERSON

social_security_number

(semi-optional)

String

The social security number of the contact information

Applicable only for contact information that represent PERSON

vat_registration_number

(semi-optional)

String

The VAT registration number of the contact information

Applicable only for contact information that represent COMPANY

registration_number

(semi-optional)

String

The registration number of the contact information

Applicable only for contact information that represent COMPANY

Available from CRM.COM R14.0.0

Response Data

Not applicable

Examples

Example 1

HTTP Method: POST

Request:

Body:

 {
"token":"{{token}}",
"contact_information_identifier":{"id":"0D93E390FA354A17A5148945A15A191D"}
}

Response:

Not applicable