Versions Compared

Key

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

Available from CRM.COM R5.0.0

Table of Contents
maxLevel2

...

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

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

...

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)

Rewards Participant IdentifierThe 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

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

...

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)

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
V4:rewards_participants_identifier

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

process_immediately

(optional)

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

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

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

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.

...

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:

Include Page
V4:customer_event_identifier
V4:customer_event_identifier

...