Associate Customer

Lets you batch register customers, or associate a customer with company or hierarchy. This API registers parent and child customers (if not registered), and associates the customer with hierarchy code, company role, parent and child customers.


Batch support is for normal customer registration

Request Body Parameters

loyaltyTypeenumLoyalty status of the customer.
profilesobjMeta information of the customer.
identifiersobjIdentifiers of the customer in type and value.
typeenumType of the customer identifier. .
valuestringValue of the specified identifier.
seriesIdintCard series ID (for card series generated in Capillary). .
seriesCodestringUnique card series code (for external card series).
statusLabelstringUser defined card status.
lastViewedDateDateDate when the customer recently opened the app.
loyaltyProgramEnrollmentsobjLets you enroll new customers in the loyalty program.
programIdintUnique ID of the loyalty program in which you want to enroll.
tierNumberintSequence number of the tier that you want to allocate to the customer.
loyaltyPointsintLoyalty points to credit in customer's account.
tierExpiryDatedate-timeExpiry date and time of the specified tier.
pointsExpiryDatedate-timeExpiry date and time of the points issued.
hierarchyCodestringUnique code of the hierarchy to associate with the customer/company. All configurations set for the hierarchy will be applicable to the customer/company.
roleCodestringPre defined role code - Role of the customer in the hierarchy.
parentCustomerobjUser profile of the parent customer.
fleetCompanyobjDetails of the company the customer is associated with.
childCustomersobjProfiles of the child customers.
externalIdstringExternal ID of the company.
profilesobjDetails of the customer to associate.
FirstnamestringFirst name of the customer.
LastnamestringLast name of the customer.
identifiersobjIdentifiers of the customer in type and value.
typeenumType of the customer identifier.
valuestringValue of the specified identifier.
commChannelsobjAvailable communication channels of the customer.
createDatedate-timeTime and date of registration in YYYY-MM-DDTHH:MM:SS+HH:MM format.
associatedWithstringThe TILL code associated with the customer registration.
extendedFieldsobjCustomer level extended field details of the customer in key:value pairs.
fieldsobjCustom field details of customers in key-value pairs.

Response parameter

idUnique ID of the entity.
profilesArray of profiles associated with the entity.
firstNameFirst name of the profile.
lastNameLast name of the profile.
attributionInformation about the profile's creation and modification.
fieldsAdditional fields associated with the profile.
identifiersArray of identifiers associated with the profile.
commChannelsCommunication channels (like email, mobile) associated with the profile.
sourceSource of the profile.
userIdUser ID associated with the profile.
accountIdAccount ID associated with the profile.
conflictingProfileListList of profiles that have conflicts.
autoUpdateTimeTime of automatic update of the profile.
loyaltyInfoLoyalty information associated with the entity.
segmentsSegments associated with the entity.
referralCodeReferral code for the entity.
associationDetailsDetails about the association of the entity.
extendedFieldsExtended fields associated with the entity.
warningsArray of warnings related to the entity.
childEntitiesArray of child entities associated with the main entity.
childCountTotal count of child entities.
childFailureCountCount of child entities that failed.
childSuccessCountCount of child entities that succeeded.
Click Try It! to start a request and see the response here!