| Tip |
|---|
Available from CRM.COM R5.0.0 |
Table of Contents maxLevel 2
GET customer_events/social_media/show
This method returns information related with a social media customer event. A single social media customer event is returned by each call
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(mandatory)
...
Customer Event identifier
The identifier of the customer event that should be returned as a result. Only customer events of type social media can be specified. The allowed customer event 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:
|
POST customer_events/social_media/list
This method returns information related with social media customer events. Multiple social media customer events are returned by each call
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
rewards_participant_identifier
(semi-optional)
...
(semi-optional)
...
Accounts Receivable Identifier
The identifier of the accounts receivable related with the customer events that should be retrieved. The allowed accounts receivable identifier fields are the following:
...
(semi-optional)
...
The identifier of the classification related with the customer events that should be retrieved. The allowed customer event classification identifier fields are the following:
...
submitted_after_date
(optional)
...
if specified then information related with social media customer events that was submitted after the specified date should be retrieved
| Tip |
|---|
Available from CRM.COM R12.2.0 |
...
submitted_before_date
(optional)
...
if specified then information related with social media customer events that was submitted before the specified date should be retrieved
| Tip |
|---|
Available from CRM.COM R12.2.0 |
...
number_of_results
(optional)
...
The number of results that can be retrieved through each call
| Tip |
|---|
Available from CRM.COM R13.0.0 |
...
offset
(optional)
...
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
| Tip |
|---|
Available from CRM.COM R13.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
...
Examples
...
| title | Example 1 |
|---|
HTTP Method: POST
Request:
Body:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"token":"476A07F7C99133EA35D9AEA25475C8C1",
"rewards_participant_identifier":{"number":"15"}
} |
Response:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
[
{
"udf_float_1": null,
"udf_float_2": null,
"udf_float_3": null,
"udf_float_4": null,
"number": "3",
"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,
"udf_string_8": null,
"social_media": "FACEBOOK",
"accounts_receivable":
{
"account_owner":
{
"last_name": "Ioannou17",
"life_cycle_state": "FINANCIAL",
"middle_name": "P",
"company_profile": null,
"title": "Mr",
"type": "PERSON",
"first_name": "Marios",
"name": "Marios Ioannou17",
"id": "D73AA349B9319CEF0C25351DF4C7DFF6",
"company_name": null,
"demographics":
{
"gender": "MALE",
"passport_issued_by_country": null,
"passport_number": "8788989",
"social_security_number": "8788980",
"country_of_residence":
{
"name": "JAPAN",
"id": "237"
},
"industry_sector": null,
"date_of_birth":
{
"month": null,
"day": null,
"year": null
},
"name_day":
{
"month": null,
"day": null
},
"id_number": "8788988",
"id_issued_by_country": null,
"industry": null
}
},
"life_cycle_state": "ACTIVE",
"number": "95",
"name": "mar17",
"id": "F5235112A7A9FFFBF8C9AE7DA20CD7C4"
},
"id": "89A283AE0BDF065C243463C1099FBDC5",
"classification":
{
"name": "Media Event Classification",
"id": "941813952637F8F744F8E9EB41F7BC26",
"alternative_code": "mec"
},
"udf_date_1": null,
"udf_date_2": null,
"profile": "www.facebook.com/crmcom",
"udf_date_3": null,
"udf_date_4": null,
"performed_by_unit":
{
"community_name": "Main Community",
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"process_immediately": 1,
"log_information":
{
"updated_date": "2014-12-04T11:27:02",
"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-13T18:53:50",
"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": null
},
"updated_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": null
}
},
"life_cycle_state": "POSTED",
"action": "LIKE",
"type": "SOCIAL_MEDIA",
"description": "Facebook like event to CRM.COM page.",
"performed_on": "2014-10-28T18:54:08"
}
]
} |
...
| title | Example 2 |
|---|
HTTP Method: POST
Request:
Body:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"token":"{{token}}",
"rewards_participant_identifier":{"number":"RP0000000054"},
"fields_set": "number,performed_on",
"submitted_after_date":"2014-07-01T17:00:12",
"submitted_before_date":"2016-11-03T15:00:12"
} |
Response:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"data": [
{
"number": "60",
"performed_on": "2016-09-02T15:49:59"
},
{
"number": "59",
"performed_on": "2016-08-30T15:49:59"
},
{
"number": "58",
"performed_on": "2016-08-30T15:49:59"
}
],
"status": {
"code": "OK",
"description": "",
"message": ""
}
} |
POST customer_events/social_media/create
This method is used to create a social media customer event in a posted life cycle state
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
accounts_receivable_identifier
(semi-optional)
...
The related accounts receivable. The allowed accounts receivable identifier fields are the following:
...
rewards_participant_identifier
(semi-optional)
...
classification_identifier
(optional)
...
performed_by_unit_identifier
(mandatory)
...
performed_on
(mandatory)
...
description
(optional)
...
process_immediately
(optional)
...
social_media
(mandatory)
...
The social media related with the customer event, which can be one of the following: FACEBOOK
...
profile
(mandatory)
...
action
(mandatory)
...
The social media action that was performed. The following actions per social media are supported (if the social media is set to Facebook) LIKE
...
external_system
(optional)
...
Defines the third party system that generates the customer event
| Tip |
|---|
Available from CRM.COM R10.0.0 |
...
external_system_reference_number
(optional)
...
Defines the unique reference number of the external system for this customer event
| Tip |
|---|
Available from CRM.COM R10.1.0 |
...
udf_string_1
(optional)
...
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
...
fields_set
(optional)
...
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
...
| title | Example 1 |
|---|
HTTP Method: POST
Request:
Body:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"token":"0924D913093D58127990487F27CEF594",
"rewards_participant_identifier":{"number":"11"},
"classification_identifier":{"name":"Event Class Test 2"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2014-05-05T15:49:59",
"description":"first purchase event",
"process_immediately":1,
"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_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",
"social_media":"FACEBOOK",
"profile":"www.facebook.com/lucia",
"action":"LIKE"
} |
Response:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"udf_float_1": 10,
"udf_float_2": 20,
"udf_float_3": 30,
"udf_float_4": 40,
"number": "6",
"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",
"social_media": "FACEBOOK",
"accounts_receivable":
{
"account_owner":
{
"last_name": "Papapavlou",
"life_cycle_state": "FINANCIAL",
"middle_name": "Andreas",
"company_profile": null,
"title": "Ms",
"type": "PERSON",
"first_name": "Lucia",
"name": "Lucia Papapavlou",
"id": "1D92B269658D80DEDF2499E25201739E",
"company_name": null,
"demographics":
{
"gender": "FEMALE",
"passport_issued_by_country":
{
"name": "GREECE",
"id": "209"
},
"passport_number": "113115",
"social_security_number": "113116",
"country_of_residence":
{
"name": "UNITED KINGDOM",
"id": "126"
},
"industry_sector":
{
"name": "GOVERNMENTAL",
"id": "A9BDEBD4D8FAEDB0BACE40C041156D12",
"alternative_code": "GOV"
},
"date_of_birth":
{
"month": 1,
"day": 1,
"year": 1990
},
"name_day":
{
"month": 5,
"day": 5
},
"id_number": "113114",
"id_issued_by_country":
{
"name": "GREECE",
"id": "209"
},
"industry":
{
"name": "Interior Design",
"id": "06B638258885DA26FA2BD40D9128D04E",
"code": "INTDS"
}
}
},
"life_cycle_state": "ACTIVE",
"number": "399",
"name": "Lucia Papapavlou",
"id": "2B669B8EB009BF42352C00B05FAB61CF"
},
"id": "9C99111B077131FA545444659366AB2A",
"classification":
{
"name": "Event Class Test 2",
"id": "C4CD55F1641D9D9711A780B6302475C0",
"alternative_code": "ect2"
},
"udf_date_1": "2014-05-05T15:49:59",
"udf_date_2": "2014-06-05T15:49:59",
"profile": "www.facebook.com/lucia",
"expected_completion_date": "2014-05-05T15:49:59",
"udf_date_3": "2014-07-05T15:49:59",
"udf_date_4": "2014-08-05T15:49:59",
"performed_by_unit":
{
"community_name": "Main Community",
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"process_immediately": 1,
"log_information":
{
"updated_date": "2014-11-14T12:58:06",
"created_by_unit":
{
"community_name": "Main Community",
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_date": "2014-11-14T12:58:05",
"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": null
},
"updated_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": null
}
},
"life_cycle_state": "POSTED",
"action": "LIKE",
"type": "SOCIAL_MEDIA",
"description": "sixth social media event"
}
} |
...
| title | Example 2 |
|---|
HTTP Method: POST
Request:
Body:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"token":"{{token}}",
"rewards_participant_identifier":{"number":"12"},
"classification_identifier":{"name":"3rd Party System Initiated"},
"performed_by_unit_identifier":{"name":"Admin Unit"},
"performed_on":"2014-05-05T15:49:59",
"description":"first purchase event",
"process_immediately":0,
"social_media":"FACEBOOK",
"profile":"www.facebook.com/lucia",
"action":"LIKE",
"fields_set":"number,id,performed_by_unit,classification,social_media,accounts_receivable,action,type,description"
} |
Response:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": {
"social_media": "FACEBOOK",
"accounts_receivable": {
"account_owner": {
"last_name": "Rewards",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Jessica",
"type": "PERSON",
"id": "79B02448A3F3A9890FCFA899A94D6D72",
"name": "Rewards Jessica",
"company_name": null,
"demographics": {
"gender": "FEMALE",
"passport_issued_by_country": null,
"social_security_number": "867583",
"passport_number": "867583",
"industry_sector": null,
"country_of_residence": {
"three_character_code": "USA",
"two_character_code": "US",
"id": "127",
"name": "UNITED STATES",
"alternative_code": null
},
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": null,
"day": null,
"year": null
},
"id_number": "867582",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR000331",
"id": "1F695BE767C2EC001433CA9E1C0F47BA",
"name": "Jessica Rewards"
},
"action": "LIKE",
"classification": {
"id": "602130E6B9F01FA657C5EC0891E93CD0",
"name": "3rd Party System Initiated",
"alternative_code": "3PSI"
},
"number": "43",
"type": "SOCIAL_MEDIA",
"id": "683B376BD8FE4996A576B225EB242A52",
"description": "first purchase event",
"performed_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
}
}
} |
POST customer_events/social_media/cancel
This method is used in order to cancel a posted social media customer event. This method can be applied only on posted social media customer events. A single social media customer event can be cancelled by each call
| Tip |
|---|
Available from CRM.COM R9.0.0 |
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
customer_event_identifier
(mandatory)
...
Customer Event identifier
The identifier of the customer event that should be cancelled. Only customer events of type social media which are posted can be specified. The allowed customer event identifier fields are the following:
...
Response Data
...
Examples
| Expand | ||||||
|---|---|---|---|---|---|---|
|
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"token":"8868DA44EBC44E81A841911932DCF561",
"customer_event_identifier":{"number":"14"}
} |
Response:
| theme | Confluence |
|---|---|
| language | javascript |
| linenumbers | true |
Deprecated from CRM.COM R15.0.0 onwards. This functionality will be provided through achievement customer events
| Panel | ||||
|---|---|---|---|---|
| ||||
|