Message Objects

Template message object

Field	Type	Meaning
templateId	string*	Whatsapp template id
components	Component Object*	Components details

Component object

Field	Type	Meaning
header	Header object[]	List of header
body	string[]	List of messages
button	Button object[]	List of button

Header object

Field	Type	Meaning
type	string*	type(image, video, document, text)
data	string*	text or url

Button object

Field	Type	Meaning
type	string*	type(URL, MPM)
index	int*	Button index
data	string*	text or url

Don't pass Button object if button type is MPM.

Event object

Field	Type	Meaning
name	string*	Name
phoneNumber	string*	Customer phone number
email	string*	Customer email
eventName	string*	Name of the event
eventProperties	[key: string]: string[]*	Event properties details

BikInitiateFlowPayload object

Field	Type	Meaning
appId	string*	App Id
medium	string*	Medium
flowId	string*	Flow Id
phoneNumber	string*	Phone number
email	string	Email of the user
nodeName	string	Name of the chatbot flow's node
channelId	string	Business phone number from which you want to trigger the flow
sessionId	string	Bik session Id
carryPayload	[key: string]: string[]	Payload
payload	AbandonedCartPayload object	AbandonedCart Payload

phoneNumber and email both are optional but at least one is required. Get yoursessionId using externalAPI block in the journey builder and scope of the sessionId is with in the flow.

AbandonedCartPayload object

Field	Type	Meaning
checkoutId	string*	Checkout Id
phoneNumber	string*	Customer Phone number
email	string	Customer email
abandonedCart	AbandonedCart object*	AbandonedCart details

AbandonedCart object

Field	Type	Meaning
id	string*	Id
phoneNumber	string*	Customer Phone number
converted	boolean*	Convert to order
cartPrice	int*	Total cart value
partnersData	PartnerData object*	PartnerData
cart	BikOrderItem object[]*	Total order items

BikOrderItem object

Field	Type	Meaning
name	string*	Product name
price	int*	Product price
quantity	int*	Product quantity
productId	int*	product id
variantId	int	Product variant id

UserProperty object

Field	Type	Meaning
userId	string	User ID
firstName	string	User first name
lastName	string	User last name
customerName	string	Customer name
name	string	Name (generic)
source	string	Source
phoneNumber	string	Phone number
alternatePhoneNumber	string	Alternate phone number
email	string	Email
webpush	string	Web push notification
address1	string	Address line 1
address2	string	Address line 2
city	string	City
state	string	State
country	string	Country
zip	string	Zip code
isTaxExempted	boolean	Tax exemption status
acceptsMarketing	boolean	Marketing acceptance status
lastOrderDate	Date/string	Date of the last order
initialOrderDate	Date/string	Date of the initial order
totalOrderCount	number	Total count of orders
totalOrderValue	number	Total value of orders
totalMessagesSent	number	Total messages sent
totalBroadcastReceived	number	Total broadcast received
lastBroadcastDate	Date/string	Date of the last broadcast
lastActivityDate	Date/string	Date of the last activity
timezone	string	Timezone
createdAt	Date/string	Creation date
updatedAt	Date/string	Last update date
emailMarketingConsent	boolean	Email marketing consent status
smsMarketingConsent	boolean	SMS marketing consent status
lastCampaignSentDate	Date	Date of the last campaign sent
tags	string[]	Tags associated with the user
partnerCustomerId	string	Partner's customer ID
orderAverage	number	Average order value
instaFollowersCount	number	Instagram followers count

RecordUserProperties object

Field	Type	Meaning
bulkUpsertUPResponse	BulkUpsertUPResponse object	BulkUpsertUPResponse details
invalidUserProperties	UserProperty object[]	InvalidUserProperties list if any

BulkUpsertUPResponse object

Field	Type	Meaning
createCount	int	Total number of user property created
updateCount	int	Total number of user property updated