customer_event_short

 customer event object response data

Name

Type

Description

id

String

The id of the retrieved customer event

number

String

The number of the retrieved customer event

life_cycle_state

String

The life cycle state of the retrieved customer event which can either be POSTED or CANCELLED

typeString

The type of the retrieved customer event which can be one of the following:

  • REFERRALS
  • ACHIEVEMENT
  • PURCHASE
  • WEB
  • SOCIAL_MEDIA
  • FINANCIAL_ACHIEVEMENT

FINANCIAL_ACHIEVEMENT type is available from CRM.COM R10.0.0

external_system_preference_numberString

The unique reference number of the customer event in the external system

Available from CRM.COM R10.1.0

classificationStringThe classification of the retrieved customer event
performed_by_unitUnit Object

The unit that initiated the customer event

Available from CRM.COM R10.1.0

Deprecated from CRM.COM R18.0.0

performed_by_business_unitBusiness Unit Object

The business unit that initiated the customer event

Available from CRM.COM R18.0.0

Referred Objects Response Data

 customer event classification object response data

Name

Type

Description

id

String

The id of the retrieved customer event classification

name

String

The name of the retrieved customer event classification

alternative_code

String

The alternative code of the retrieved customer event classification

 unit object response data

Name

Type

Description

id

String

The ID of the retrieved unit

name

String

The name of the retrieved unit

group_name

String

The name of the group that the retrieved unit belongs to

community_name

String

The name of the community that the retrieved unit belongs to

alternative_code

String

The alternative code of the retrieved unit

description

String

The description of the retrieved unit

 business unit object response data

Name

Type

Description

id

String

The ID of the retrieved business unit

name

String

The name of the retrieved business unit

codeStringThe code of the retrieved business unit
unified_codeString

The unified code of the retrieved business unit

description

String

The description of the retrieved business unit

parent_business_unit_nameStringThe name of the parent business unit that the retrieved business unit belongs to