| Table of Contents | ||
|---|---|---|
|
...
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:
| ||||||
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 |
...
This method returns information related with contact information. Multiple contact information can be returned by each call
| Tip |
|---|
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 | ||
email_address (semi-optional) | String | The email address of the contact information
| ||
phone_number (semi-optional) | String | The phone number of the contact information
| ||
number_of_results (optional) | Number | The number of results that can be retrieved through each call
| ||
offset (optional) | Number | Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number
| ||
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 |
...
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:
| ||||||
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:
| ||||||
owned_by_group_identifier (optional) | Group identifier | The group owning the contact information. The allowed group identifier fields are the following:
| ||||||
privacy_level_identifier (optional) | Privacy level identifier | The privacy level of the contact information. The allowed privacy level identifier fields are the following:
| ||||||
notes (optional) | String | Notes for the contact information | ||||||
send_direct_marketing_material (optional) | Boolean
| The Contact Information's authorization setting for Direct Marketing
| ||||||
send_affiliate_marketing_material (optional) | Boolean | The Contact Information's authorization setting for Affiliate Marketing
| ||||||
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 | ||||||
(optional) | Demographics object | The demographics of the contact information. Applicable only if the type is PERSON
| ||||||
(optional) | Company profile object | The company profile of the contact information. Applicable only if the type is COMPANY
| ||||||
(optional) | Address object | The addresses of the contact information
| ||||||
(optional) | Phone object | The phone of the contact information
| ||||||
(optional) | Email object | The email of the contact information
| ||||||
(optional) | Contact Information business and personal relation object
| The business and personal relations 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
|
Anchor contact_information_create referred objects parameters contact_information_create referred objects parameters
Referred Parameter Objects Data
| contact_information_create referred objects parameters | |
| contact_information_create referred objects 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:
| ||||||||
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:
| ||||||||
owned_by_group_identifier (optional) | Group identifier | The group owning the contact information. The allowed group identifier fields are the following:
| ||||||||
privacy_level_identifier (optional) | Privacy level identifier | The privacy level of the contact information. The allowed privacy level identifier fields are the following:
| ||||||||
notes (optional) | String | Notes for the contact information | ||||||||
send_direct_marketing_material (optional) | Boolean
| The Contact Information's authorization setting for Direct Marketing
| ||||||||
send_affiliate_marketing_material (optional) | Boolean
| The Contact Information's authorization setting for Affiliate Marketing
| ||||||||
preferred_language (optional)
| String | The Contact Information's preferred language. The available options are:
| ||||||||
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 | ||||||||
(optional) | Demographics object | The demographics of the contact information. Applicable only if the type is PERSON
| ||||||||
(optional) | Company profile object | The company profile of the contact information. Applicable only if the type is COMPANY
| ||||||||
(optional) | Address object | The addresses of the contact information
| ||||||||
(optional) | Phone object | The phone of the contact information
| ||||||||
(optional) | Email object | The email of the contact information
| ||||||||
(optional)
| Contact Information business and personal relation object
| The business and personal relations of the contact information
| ||||||||
(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
|
Anchor contact_information_create referred objects parameters contact_information_create referred objects parameters
Referred Parameter Objects Data
| contact_information_create referred objects parameters | |
| contact_information_create referred objects parameters |
...
GET contact_information/profile_photo/view
| Tip |
|---|
Available from CRM.COM R11.0.0 |
This method returns the profile photo information related with a contact information
...
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:
| ||||||
fields_set | 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 |
...
POST contact_information/profile_photo/add
| Tip |
|---|
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
...
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:
| ||||||
file (semi-optional) | File | The file that should be added as a profile picture | ||||||
fields_set | 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 |
...
POST contact_information/profile_photo/remove
| Tip |
|---|
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
...
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:
|
...