Versions Compared

Old Version 2

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user Joseph Ioannou

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...


Tip

Available from CRM.COM R10.0.0

Deprecated from CRM.COM R15.0.0 onwards. This functionality will be provided through achievement customer events


Excerpt

This method is used to create multiple social media customer events within a single Web API method call. Note that the maximum number of social media customer events that can be created is 1000

...

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

social_media_customer_events_set

(mandatory)

Set of Social Media Customer Event Objects

The set of social media customer events that will be created by this Web API method.

Note that the maximum number of social media 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

...

Expand
titlebulk social media customer event parameter object data


Name

Type

Description

request_unique_identifier

(mandatory)

StringA 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

accounts_receivable_identifier

(semi-optional)

Accounts receivable Identifier

The related accounts receivable. The allowed accounts receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

rewards_participant_identifier

(semi-optional)

Rewards Participant IdentifierThe related rewards participant. The allowed rewards participant identifier fields are the following:

Include Page
V4:rewards_participants_identifier_post
V4:rewards_participants_identifier_post

classification_identifier

(optional)

Customer Event Classification IdentifierThe 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_unit_identifier

(mandatory)

Unit IdentifierThe unit that initiated the customer event. The allowed unit identifier fields are the following:

Include Page
V4:unit_identifier
V4:unit_identifier

performed_on

(mandatory)

DateThe date that the customer event was actually performed

description

(optional)

StringA description of the customer event

social_media

(mandatory)

String

The social media related with the customer event, which can be one of the following: FACEBOOK

profile

(mandatory)

StringThe 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)

StringThe 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


...

Expand
titleExample 1

HTTP Method: POST

 


Request:

Body:

Code Block
language
languagejavascript
themeConfluence
javascriptlinenumberstrue
 {
   "token":"{{token}}",

  "social_media_customer_events_set":
   [
        {
            "request_unique_identifier":"16",
            "accounts_receivable_identifier":{"number":"ACR0000000164"},
            "performed_by_unit_identifier":{"name":"Admin Unit"},
            "performed_on":"2016-06-22T15:00:00",
            "social_media":"FACEBOOK",
            "profile":"www.facebook.com/polina",
            "action":"LIKE"
        },
        {
            "request_unique_identifier":"17",
            "accounts_receivable_identifier":{"number":"ACR0000000050"},
            "performed_by_unit_identifier":{"name":"Admin Unit"},
            "performed_on":"2016-06-22T15:05:02",
            "social_media":"FACEBOOK",
            "profile":"www.facebook.com/katerina",
            "action":"LIKE"
        },
        {
            "request_unique_identifier":"18",
            "accounts_receivable_identifier":{"number":"ACR00045750"},
            "performed_by_unit_identifier":{"name":"Admin Unit"},
            "performed_on":"2016-06-22T15:19:22",
            "social_media":"FACEBOOK",
            "profile":"www.facebook.com/marios",
            "action":"LIKE"
        },
        {
            "request_unique_identifier":"19",
            "accounts_receivable_identifier":{"number":"ACR00670000"},
            "performed_by_unit_identifier":{"name":"Admin Unit"},
            "performed_on":"2016-06-22T15:15:42",
            "social_media":"FACEBOOK",
            "profile":"www.facebook.com/yiannis",
            "action":"LIKE"
        }
  
    ]
}


Response:

Code Block
languagejavascript
themeConfluencelanguagejavascript
linenumberstrue
 {
  "data": {
    "unprocessed_customer_events_set": [
      {
        "error_description": "Error:Account (ACR00045750) Not Found. - Description:The specified API value was not found.",
        "error_code": "NotFoundAPIValueException",
        "request_unique_identifier": "18"
      },
      {
        "error_description": "Error:Account (ACR00670000) Not Found. - Description:The specified API value was not found.",
        "error_code": "NotFoundAPIValueException",
        "request_unique_identifier": "19"
      }
    ],
    "processed_customer_events_set": [
      {
        "number": "14",
        "id": "49A9DF458B6E4DE69CDC7F5E330F34D9",
        "request_unique_identifier": "16"
      },
      {
        "number": "15",
        "id": "CB54467A5FA445359962283134E1473D",
        "request_unique_identifier": "17"
      }
    ]
  },
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}


...