| Tip |
|---|
Available from CRM.COM R10.0.0 |
| Excerpt |
|---|
This method is used to create multiple referral customer events within a single Web API method call. Note that the maximum number of referral customer events that can be created is 1000 |
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
referral_customer_events_set
(mandatory)
...
Set of Referral Customer Event Objects
...
The set of Referral customer events that will be created by this Web API method. Note that the maximum number of referral customer events that can be specified within a single Web API call is 1000
...
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
...
| title | bulk referral customer event parameter object data |
|---|
...
Name
...
Type
...
Description
...
request_unique_identifier
(mandatory)
...
classification_identifier
(optional)
...
performed_by_unit_identifier
(mandatory)
...
| Tip |
|---|
Available from CRM.COM R10.0.0 |
| Excerpt |
|---|
This method is used to create multiple referral customer events within a single Web API method call. Note that the maximum number of referral customer events that can be created is 1000 |
Resource URL
Parameters
Name | Type | Description |
token | String | The token retrieved from the login method |
referral_customer_events_set (mandatory) | Set of Referral Customer Event Objects | The set of Referral customer events that will be created by this Web API method. Note that the maximum number of referral customer events that can be specified within a single Web API call is 1000 |
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 |
|---|
| bulk create referral parameters |
|---|
| bulk create referral parameters |
|---|
|
Referred Parameter Objects
| Expand |
|---|
| title | bulk referral customer event parameter object data |
|---|
|
Name | Type | Description | request_unique_identifier (mandatory) | String | A unique identifier of the request, provided by the caller, in order to identify the successful or failed results. Note that this information should be unique and is not stored within CRM.COM | classification_identifier (optional) | Customer Event Classification Identifier | The classification of the customer event. The allowed customer event classification identifier fields are the following:| Include Page |
|---|
| V4:customer_event_classification_identifier |
|---|
| V4:customer_event_classification_identifier |
|---|
|
| performed_by_business_unit_identifier (semi-optional) | Business Unit Identifier | The business unit that initiated the customer event. The allowed identifier fields are the following| Include Page |
|---|
| V4:business_unit_identifier |
|---|
| V4:business_unit_identifier |
|---|
|
| Tip |
|---|
Available from CRM.COM R18.0.0 |
| performed_by_unit_identifier (semi-optional) | Unit Identifier | The unit that initiated the customer event. The allowed identifier fields are the following| Include Page |
|---|
| V4:unit_identifier |
|---|
| V4:unit_identifier |
|---|
|
| Tip |
|---|
For releases prior CRM.COM R17.0.0, this attribute was mandatory From CRM.COM R17.0.0, this attribute will be set automatically if the performed_by_device_identifier is specified Deprecated from CRM.COM R18.0.0 |
| performed_by_tap_identifier (semi-optional) | Transaction Acquiring Point Identifier | The unit's transaction acquiring point that initiated the customer event. The allowed identifier fields are the following | Include Page |
|---|
| V4:transaction_acquiring_point_identifier |
|---|
| V4:transaction_acquiring_point_identifier |
|---|
|
| Tip |
|---|
Available from CRM.COM R17.0.0 From CRM.COM R17.0.0, this attribute will be set automatically if the performed_by_unit_identifier is specified From CRM.COM R18.0.0, this attribute will be set automatically if the performed_by_business_unit_identifier is specified |
| performed_on (mandatory) | Date | The date that the customer event was actually performed | description (optional) | String | A description of the customer event | referred_accounts_receivable_identifier (mandatory) |
Rewards Participant | Accounts Receivable Identifier | The referred accounts receivable. The allowed identifier fields are the following: | Include Page |
|---|
| V4:rewards_participants_identifier_post |
|---|
| V4:rewards_participants_identifier_post |
|---|
|
| Tip |
|---|
Available from CRM.COM R17.0.0 |
| referred_by_accounts_receivable_identifier (mandatory) |
Rewards Participant | Accounts Receivable Identifier | The accounts receivable that provided the referral. The allowed identifier fields are the following:| Include Page |
|---|
| V4:rewards_participants_identifier_post |
|---|
| V4:rewards_participants_identifier_post |
|---|
|
| Tip |
|---|
Available from CRM.COM R17.0.0 |
| referred_rewards_participant_identifier (mandatory) | Rewards Participant Identifier | The referred rewards participant. The allowed identifier fields are the following:| Include Page |
|---|
| V4:rewards_participants_identifier_post |
|---|
| V4:rewards_participants_identifier_post |
|---|
|
| Tip |
|---|
Deprecated from CRM.COM R17.0.0 |
| referred_by_rewards_participant_identifier (mandatory) | Rewards Participant Identifier | The rewards participant that provided the referral. The allowed identifier fields are the following:| Include Page |
|---|
| V4:rewards_participants_identifier_post |
|---|
| V4:rewards_participants_identifier_post |
|---|
|
| Tip |
|---|
Deprecated from CRM.COM R17.0.0 |
| external_system (optional) | String | The third party system that generates the customer event | external_system_reference_number (optional) | String | The unique reference number of the customer event in the external system | Tip |
|---|
Available from CRM.COM R10.1.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_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 |
|
Response Data
| Include Page |
|---|
| V4:bulk_customer_event_complete |
|---|
| V4:bulk_customer_event_complete |
|---|
|
...