| Tip |
|---|
Available from CRM.COM R5.0.0 |
Table of Contents maxLevel 2
...
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 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 |
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
rewards_participant_identifier (semi-optional) | Rewards Participant Identifier | The identifier of the rewards participant related with the customer events that should be retrieved. The allowed rewards participant identifier fields are the following:
| ||||||
| accounts_receivable_identifier (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:
| ||||||
| classification_identifier (semi-optional) | Customer Event Classification Identifier | 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)
| Date | if specified then information related with social media customer events that was submitted after the specified date should be retrieved
| ||||||
submitted_before_date (optional) | Date | if specified then information related with social media customer events that was submitted before the specified date should be retrieved
| ||||||
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 | ||||||
accounts_receivable_identifier (semi-optional) | Accounts receivable Identifier | The related accounts receivable. The allowed accounts receivable identifier fields are the following:
| ||||||
rewards_participant_identifier (semi-optional) | Rewards Participant Identifier | The related rewards participant. The allowed rewards participant identifier fields are the following:
| ||||||
classification_identifier (optional) | Customer Event Classification Identifier | The classification of the customer event. The allowed customer event classification identifier fields are the following:
| ||||||
performed_by_unit_identifier (mandatory) | Unit Identifier | The unit that initiated the customer event. The allowed unit identifier fields are the following:
| ||||||
performed_on (mandatory) | Date | The date that the customer event was actually performed | ||||||
description (optional) | String | A description of the customer event | ||||||
process_immediately (optional) | boolean | Defines if the customer event was processed immediately by various business processes or not | ||||||
social_media (mandatory) | String | The social media related with the customer event, which can be one of the following: FACEBOOK | ||||||
profile (mandatory) | String | The social media profile related with the customer event | ||||||
action (mandatory) | String | 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) | String | Defines the third party system that generates the customer event
| ||||||
external_system_reference_number (optional) | String | Defines the unique reference number of the external system for this customer event
| ||||||
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 | ||||||
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.
...
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:
|
...