Group Points Transferrable

Checks if specific points from one account can be transferred to another account (group to customer, customer to a group, or one group to another).

Request Body Parameters

ParameterDataTypeDescription
pointsTobeTransferredintNumber of points to be transferred.
notesstringNotes to be added to the transfer activity.
programIdintLoyalty program ID from which points has to be transferred. Applicable for multi-program orgs. Considers the default program ID if not passed.
transferredByobjDetails of the user who is transferring points.
toEntityobjDetails of the destination account (customer or group) - to which the points need to be transferred.
fromEntityobjDetails of the source account (group or customer) from which the points need to be transferred.

transferredBy, toEntity and fromEntity Object Parameters

ParameterDataTypeDescription
typeEnumType of the entry.
Value: CUSTOMER, USERGROUP2
identifierTypeEnumIdentifier type to identify customer or group.
Supported values for customer: mobile, email, externalId, cardnumber, wechat, martjackId, fbId.
Supported values for group: id, externalId, primaryUserId, primaryUserCardnumber, primaryUserMobile, primaryUserEmail.
identifierValuestringValue of the specifier identifierType.
SourceEnumSource in which the customer account is available.
Value: FACEBOOK, WEB_ENGAGE, WECHAT, INSTORE, MARTJACK, TMALL, TAOBAO, JD, ECOMMERCE, WEBSITE, LINE, MOBILE_APP.
Required for customer entity.
accountIdstringAccount Ids for sources with multiple account IDs.
Language
Authorization
Basic
base64
:
URL
Click Try It! to start a request and see the response here!