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:

Include Page

	V4:customer_event_identifier
	V4:customer_event_identifier

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:

Include Page

	V4:rewards_participants_identifier
	V4:rewards_participants_identifier

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:

Include Page

	V4:accounts_receivable_identifier
	V4:accounts_receivable_identifier

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:

Include Page

	V4:customer_event_classification_identifier
	V4:customer_event_classification_identifier

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

Tip
Available from CRM.COM R12.2.0

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

Tip
Available from CRM.COM R12.2.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

...

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	js
linenumbers	true

{
  "token":"476A07F7C99133EA35D9AEA25475C8C1",
  "rewards_participant_identifier":{"number":"15"}
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 

      {
    "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"
        }
    ]
}

Expand

title	Example 2

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	js
linenumbers	true

{
    "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

theme	Confluence
language	javascript
linenumbers	true

 {
  "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

...

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:

Include Page

	V4:accounts_receivable_identifier
	V4:accounts_receivable_identifier

rewards_participant_identifier

(semi-optional)

Rewards Participant Identifier

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

Include Page

	V4:rewards_participants_identifier
	V4:rewards_participants_identifier

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_unit_identifier

(mandatory)

Unit Identifier

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

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

Tip
Available from CRM.COM R10.0.0

external_system_reference_number

(optional)

String

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)

String