Register Multiple for Current Member

Registers mobile events for current OAuth member

Body Parameters

Parameter	Type	Required?	Comments
bulk	Array[Object]	yes
bulk.event_type	String	yes	See below for a list of possible values
bulk.created_at	DateTime	yes
bulk.member_id	Integer	no
bulk.properties	Object	yes

Below is the description of bulk.properties parameters.

Parameter	Type	Required?	Comments
app_version	String	no	empty string is not allowed
article_id	String	no
beacon_id	String	no	empty string is not allowed
beacon_location_id	String	no	empty string is not allowed
beacon_distance	String	no	one of : 'unknown', 'far', 'near', 'immediate'
bluetooth_enabled	Boolean	no
card_id	String	no
category_id	String	no
distinct_id	String	no	empty string is not allowed
ip_address	String	no
location_enabled	Boolean	no
location_mode	String	no	empty string is not allowed
member_id	Integer	no
message_id	String	no	empty string is not allowed
msisdn	String	no	empty string is not allowed, must have a valid format
mobile_number	String	no
name	String	no
offer_collection_id	String	no
offer_id	String	no
order_id	String	no	empty string is not allowed
os_version	String	no	empty string is not allowed
page	Integer	no
platform	String	no	one of : 'android', 'ios'
product_collection_id	String	no	empty string is not allowed
product_id	String	no	empty string is not allowed
products	Array[String]	no
push_data	Object	no
push_enabled	Boolean	no
receipt_id	String	no
screen_dpi	Integer	no
screen_height	Integer	no
screen_width	Integer	no
sender	String	no
shop_id	String	no
status	String	no	empty string is not allowed
tab	String	no	empty string is not allowed
token	String	no	empty string is not allowed
type	String	no
uri	String	no
share_type	String	no
wifi_enabled	Boolean	no
transition_type	String	no
reason	String	no
identifier	String	no
email	String	no
queued_sms	String	no
offer_version	Integer	no
menu_item	String	no
geofencing	Boolean	no
source	String	no
reward_id	String	no
app_tracking_status	String	no
car_lpn	String	no
benefit_id	Integer	no

Possible bulk.event_type values (grouped by type):

welcome_pages:open
welcome_pages:close
webpage:open

loyalty:gift_card_collection:open
loyalty:stamp_card_collection:open
loyalty:stamp_card_collection:open
loyalty:stamp_card:negative_stamps:open
loyalty:gift_card:open
loyalty:receipt:open
loyalty:receipt_collection:open

shops:open
shops:list:view
shops:map:view
shops:list:item:click
shops:item:call
shops:map:item:click
shops:item:route
shop_list:open
shop:open
shop:call
opening_hours:open

login:skipped
login:success:guest
login:success
login:open
login:number_invalid
login:failed
login:user_missing
login:user_exists

registration:success
registration:invalid_form

profile:updated
profile:logout
profile:open

member_card:open
interests:open
terms:open

offer_collections:open
offer_collection:view
offer:click
offer:view
offer:activate
offer:activate_confirm
offer:activated
offer:like
offer:dislike
offer:shared
offer:share:cancelled
offer:share:confirmed

product_collections:open
product_collection:view
product:click
product:added_to_favourites
product:removed_from_favourites
product:click_from_favourites
product:added_to_cart
product:removed_from_cart
similar_product:click

order:checkout_dialog_open
order:checkout
order:cancel_dialog_open
order:cancelled

cac_tab:open
cac_onboarding:accepted
cac_onboarding:declined
cac_filters:open

beacon:proximity
beacons:settings:open

articles:open
article:open
article:used

link:click
link:open

vcs:open
vcs:optional_update_clicked
vcs:optional_update_postponed
vcs:forced_update_clicked
vcs:forced_update_declined

raf:consent_open
raf:consent_confirmed
raf:consent_declined
raf:link_copied
raf:link_shared
raf:info_clicked

geofencing:enabled
geofencing:disabled
geofencing:geofences_added
geofencing:geofences_removed
geofencing:transition_registered
geofencing:notification_failed
geofencing:notification_succeed

consents:success
consents:failure
consents:screen_open
consents:dismiss

offer:open
offer_collection:view
offer:click
offer:activate
offer:activate_confirm
offer:activated
offer:like
offer:dislike
offer:like_selected
offer:like_deselected
offer:filters_selected
offer:shared
offer:share:cancelled
offer:share:confirmed
offer:deeplink_clicked

rewards:open
rewards:dashboard:open
rewards:shop_screen:open
rewards:points_screen:open
rewards:shop_tab:open
rewards:shop_tab_history:open
rewards:points_tab_history:open
rewards:points_tab:open
rewards:info:open
rewards:your_activities:open
rewards:reward:clicked
rewards:buy_reward:clicked
rewards:buy_reward_confirmation:clicked
rewards:buy_reward_confirmation:denied
rewards:use_reward:clicked
rewards:use_reward_confirmation:clicked
rewards:use_reward_confirmation:denied
rewards:setting:open
rewards:opt_out:clicked
rewards:opt_out_confirmation:clicked
rewards:opt_out_confirmation:denied
rewards:opt_in:clicked
rewards:opt_in_confirmation:clicked
rewards:opt_in_confirmation:denied

my_product:item:view
my_product:open

event:open
event:dislike_selected
event:like_selected
event:click
event:register
event:unregister
event:signup_waiting_list
event:like
event:dislike
event:shared
event:share:cancelled
event:share:confirmed
event:add_to_calendar

notification:open

cars:open
cars:information_open
cars:edit_open
cars:benefits_open
cars:benefits_details_open

NOTE : bulk.properties.message_id parameter is needed for event_type notification:open if we want to create artificial sending event

Example

When successful, returns an object structured like below:

{
  "success": "12652a60129abef196223b97"
}

Request

Header Params

Content-Type

enum<string>

required

Details

Allowed value:

application/json

Default:

application/json

X-User-Agent

string

required

Arbitrary identifier of your client. Details

Default:

X-Product-Name

string

required

API Product for API context. Details

Default:

X-Loyalty-Club-Slug

string

required

LoyaltyClub for API context. Details

Default:

X-Customer

string

required

Customer for API context. Details

Default:

Authorization

string

required

Member or User Authorization.

Default:

Bearer {{_OAUTH_TOKEN}}

X-Client-Authorization

string

optional

Default:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Register Multiple for Current Member

Body Parameters#

Possible bulk.event_type values (grouped by type):#

Example#

Request

Request samples

Responses

Body Parameters

Possible bulk.event_type values (grouped by type):

Example