put https://{host}/v2/events
Lets you add or remove fields and customers for an event. You need to pass the entire payload of the event.
Request Body Parameters
Parameter | Type | Description |
---|---|---|
eventName* | string | Name of the event. |
actions* | enum | Destination of the event. Values: EMFConsumer for EMF related events: Loyalty, DVS, and Communication, EIConsumer for Essential Insights. |
description | string | A short description for the event. |
fields | obj | Configure fields for the current event with attributes: name , type , and value .- addCustomerIfNotExists - Adds the customer if the customer does not exist.- isRequired - Marks the attribute as mandatory- isUniqueKeyField - Includes the attribute, to the unique key. Once defined as a unique key field, this attribute becomes mandatory and needs to be marked as isRequired . By default, customer identifier and event name are already part of the unique key. |
name | string | Name of the field. |
type | enum | Specify the type of the attribute. Values: tillCode , couponCode , customer , productSku , productBrand , productCategory , string , double . |
addCustomerIfNotExists | obj | Set this value to true to allow registering new customers in to the loyalty program automatically |
valueType | enum | Data-type of the attribute. For example, Boolean , Enum , String . |
value | string | Value of the attribute based on its valueType .For example, if valueType is Boolean, value could be either true or false . |