| Table of Contents | ||
|---|---|---|
|
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
...
(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
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
GET contact_information/list
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 |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Multiple semi-optional parameters can be specified in each call
Response Data
...
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
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)
...
The company name of the contact information. Applicable and mandatory only if the type is COMPANY
...
preferred_language
(optional)
...
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
| Tip |
|---|
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:
...
owned_by_group_identifier
(optional)
...
The group owning the contact information. The allowed group identifier fields are the following:
...
privacy_level_identifier
(optional)
...
The privacy level of the contact information. The allowed privacy level identifier fields are the following:
...
notes
(optional)
...
send_direct_marketing_material
(optional)
...
Boolean
...
The Contact Information's authorization setting for Direct Marketing
| Tip |
|---|
Available from CRM.COM R9.0.0 |
...
send_affiliate_marketing_material
(optional)
...
Boolean
...
The Contact Information's authorization setting for Affiliate Marketing
| Tip |
|---|
Available from CRM.COM R9.0.0 |
...
udf_string_1
(optional)
...
User Defined Field of type String
...
udf_string_2
(optional)
...
User Defined Field of type String
...
udf_string_3
(optional)
...
User Defined Field of type String
...
udf_string_4
(optional)
...
User Defined Field of type String
...
udf_string_5
(optional)
...
User Defined Field of type String
...
udf_string_6
(optional)
...
User Defined Field of type String
...
udf_string_7
(optional)
...
User Defined Field of type String
...
udf_string_8
(optional)
...
User Defined Field of type String
...
udf_string_9
(optional)
...
User Defined Field of type String
...
udf_string_10
(optional)
...
User Defined Field of type String
...
udf_string_11
(optional)
...
User Defined Field of type String
...
udf_string_12
(optional)
...
User Defined Field of type String
...
udf_string_13
(optional)
...
User Defined Field of type String
...
udf_string_14
(optional)
...
User Defined Field of type String
...
udf_string_15
(optional)
...
User Defined Field of type String
...
udf_string_16
(optional)
...
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)
...
The addresses of the contact information
...
(optional)
...
The phone of the contact information
...
(optional)
...
The email of the contact information
...
(optional)
...
Contact Information business and personal relation object
...
The business and personal relations of the contact information
| Tip |
|---|
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
| Tip |
|---|
Available from CRM.COM R10.0.0 |
...
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Examples
| Expand | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|
...
| title | Example 2 |
|---|
HTTP Method: POST
Request:
Body:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"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:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"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
}
} |
...
| title | Example 3 |
|---|
HTTP Method: POST
Request:
Body:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"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:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"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)
...
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)
...
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)
...
The group owning the contact information. The allowed group identifier fields are the following:
...
privacy_level_identifier
(optional)
...
The privacy level of the contact information. The allowed privacy level identifier fields are the following:
...
notes
(optional)
...
send_direct_marketing_material
(optional)
...
Boolean
...
The Contact Information's authorization setting for Direct Marketing
| Tip |
|---|
Available from CRM.COM R9.0.0 |
...
send_affiliate_marketing_material
(optional)
...
Boolean
...
The Contact Information's authorization setting for Affiliate Marketing
| Tip |
|---|
Available from CRM.COM R9.0.0 |
...
preferred_language
(optional)
...
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
| Tip |
|---|
Available from CRM.COM R12.0.0 |
...
udf_string_1
(optional)
...
User Defined Field of type String
...
udf_string_2
(optional)
...
User Defined Field of type String
...
udf_string_3
(optional)
...
User Defined Field of type String
...
udf_string_4
(optional)
...
User Defined Field of type String
...
udf_string_5
(optional)
...
User Defined Field of type String
...
udf_string_6
(optional)
...
User Defined Field of type String
...
udf_string_7
(optional)
...
User Defined Field of type String
...
udf_string_8
(optional)
...
User Defined Field of type String
...
udf_string_9
(optional)
...
User Defined Field of type String
...
udf_string_10
(optional)
...
User Defined Field of type String
...
udf_string_11
(optional)
...
User Defined Field of type String
...
udf_string_12
(optional)
...
User Defined Field of type String
...
udf_string_13
(optional)
...
User Defined Field of type String
...
udf_string_14
(optional)
...
User Defined Field of type String
...
udf_string_15
(optional)
...
User Defined Field of type String
...
udf_string_16
(optional)
...
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)
...
The addresses of the contact information
...
(optional)
...
The phone of the contact information
...
(optional)
...
The email of the contact information
...
(optional)
...
Contact Information business and personal relation object
The business and personal relations of the contact information
...
| Tip |
|---|
Available from CRM.COM R5.0.0 |
(optional)
...
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
...
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Examples
...
| title | Example 1 |
|---|
HTTP Method: POST
Request:
Body:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"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:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"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
| Tip |
|---|
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
...
(mandatory)
...
Identifier
The identifier of the contact information that should be retrieved. 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
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
...
Examples
| Expand | |||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||
HTTP Method: GET
Request: Response:
Note: To retrieve or display the actual image you need to construct the following URL
for example
|
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
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(mandatory)
...
Identifier
The identifier of the contact information that should be updated. The allowed contact information identifier fields are the following:
...
file
(semi-optional)
...
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
...
Examples
| Expand | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
cURL Example:
PHP Example:
|
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
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(mandatory)
...
Identifier
The identifier of the contact information that should be updated. The allowed contact information identifier fields are the following:
...
Response Data
Not applicable
Examples
| Expand | ||||||
|---|---|---|---|---|---|---|
|
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"token":"{{token}}",
"contact_information_identifier":{"id":"0D93E390FA354A17A5148945A15A191D"}
} |
Response:
Not applicable
| name | blue |
|---|
| Child pages (Children Display) | ||
|---|---|---|
|