# To deduct points, redeem points and award loyalty points to a member

Use the POST method in the Points API to redeem points and award points to members of the loyalty program. All other fields in the request body are listed below.

Endpoint: POST /points
Version: 3.0.0
Security: 

## Request fields (application/json):

  - `body` (object)
    Different body parameters are shown below depending on whether you’d like to redeem points or award points.

  - `body.To Redeem Rewards` (object)

  - `body.To Redeem Rewards.id` (string, required)
    Enter the unique ID for the member.
    Example: "user@domain.com"

  - `body.To Redeem Rewards.actionId` (integer, required)
    Enter the unique action ID for the redemption of rewards performed by the member.
    Example: 107

  - `body.To Redeem Rewards.customId` (string)
    Enter a unique ID to associate with the Action ID to support unique transactions.
    Example: "gadget01"

  - `body.To Redeem Rewards.rewardId` (string, required)
    Enter the specific reward ID that the member wants to claim or redeem. The reward should be configured in the site admin.
    Example: "121"

  - `body.To Redeem Rewards.groupId` (string)
    Enter the member’s group ID if they’d like to redeem the reward using points from the group points balance. Note - If the Enable Auto Group Points Redemption flag is turned on in the Hierarchy Management settings, all redeemed points are automatically deducted from the group point balance, eliminating the need to include the group ID in the request.
    Example: "91"

  - `body.To Redeem Rewards.activity` (string, required)
    Enter debit in the activity field to indicate that the member is redeeming their points.
    Example: "DEBIT"

  - `body.To Redeem Rewards.orderId` (string)
    Enter the loyalty member's order ID.
    Example: "A12345"

  - `body.To Redeem Rewards.retry` (string)
    The retry parameter's function is to ensure there aren't any duplicate order IDs. ‘YES’ should be entered if points have been previously redeemed for the same order. ‘NO’ should be entered if points have not been previously redeemed for the same order.
    Example: "YES"

  - `body.To Redeem Rewards.reason` (string)
    Enter the reason for deducting points from the member’s account.
    Example: "points redeemed for discount"

  - `body.To Redeem Rewards.storeId` (string)
    Enter the store ID, a unique number used to identify the specific store. Note - If a store ID is provided with any action and it exists in the metadata, all associated attributes of that store will be displayed. If the store ID does not exist in the metadata, it will simply display the store ID itself.
    Example: "IN12369"

  - `body.To Redeem Rewards.source` (string)
    Enter the source from where the member performed the transaction. For example, Web or App.
    Example: "web"

  - `body.To Redeem Rewards.allowNegativePoints` (string)
    Enter the following options for handling negative points. 1 - Do Not Allow Negative Points 2 - Allow Negative Points 3 - Set Balance to Zero.
    Example: "2"

  - `body.To Redeem Rewards.vendorEmail` (string)
    Enter the vendor’s unique email address.
    Example: "vendor@domain.com"

  - `body.To Redeem Rewards.vendorName` (string)
    Enter the vendor’s name.
    Example: "John mark"

  - `body.To Redeem Rewards.actionAttribute` (object)
    Action attributes allow you to capture additional metadata about an action. If you are leveraging action attributes, enter the following data.

  - `body.To Redeem Rewards.actionAttribute.attributeValue` (string)
    Enter the attribute name that has been added to the action. This attribute is nested within the action attribute object, where the parameter specifies an attribute name and the parameter value enters the shared metadata.
    Example: "shirt size"

  - `body.To Redeem Custom Points` (object)
    Note - Custom points are not predefined in the system, instead, they are set and managed based on specific user-defined criteria.

  - `body.To Redeem Custom Points.id` (string, required)
    Enter the unique ID for the member.
    Example: "user@domain.com"

  - `body.To Redeem Custom Points.actionId` (integer, required)
    Enter the unique action ID for the redemption of custom points performed by the member.
    Example: 107

  - `body.To Redeem Custom Points.customId` (string)
    Enter a unique ID to associate with the Action ID to support unique transactions.
    Example: "gadget01"

  - `body.To Redeem Custom Points.activity` (string, required)
    Enter debit in the activity field to indicate that the member is redeeming their custom points.
    Example: "DEBIT"

  - `body.To Redeem Custom Points.orderId` (string, required)
    Enter the loyalty member's order ID.
    Example: "A12345"

  - `body.To Redeem Custom Points.debit` (integer, required)
    Enter the number of points debited from the member’s account for redeeming custom points by performing the redemption action.
    Example: 121

  - `body.To Redeem Custom Points.reason` (string)
    Enter the reason for removing points from the member’s account to redeem custom points.
    Example: "custom points redeemed for discount"

  - `body.To Redeem Custom Points.storeId` (string)
    Enter the store ID, a unique number used to identify the specific store. Note - If a store ID is provided with any action and it exists in the metadata, all associated attributes of that store will be displayed. If the store ID does not exist in the metadata, it will simply display the store ID itself.
    Example: "IN12369"

  - `body.To Redeem Custom Points.source` (string)
    Enter the source from where the member performed the transaction. For example, Web or App.
    Example: "web"

  - `body.To Redeem Custom Points.actionAttribute` (object)
    Action attributes allow you to capture additional metadata about an action. If you are leveraging action attributes, enter the following data.

  - `body.To Redeem Custom Points.actionAttribute.attributeValue` (string)
    Enter the attribute name that has been added to the action. This attribute is nested within the action attribute object, where the parameter specifies an attribute name and the parameter value enters the shared metadata.
    Example: "shirt size"

  - `body.To Award Points` (object)

  - `body.To Award Points.id` (string, required)
    Enter the unique ID for the member.
    Example: "user@domain.com"

  - `body.To Award Points.actionId` (integer, required)
    Enter the unique action ID of the action for which points are being awarded to the member. For example, the action ID for manual credit is 100.
    Example: 100

  - `body.To Award Points.customId` (string)
    Enter a unique ID to associate with the Action ID to support unique transactions.
    Example: "gadget01"

  - `body.To Award Points.activity` (string, required)
    Enter credit in the activity field to indicate that the points are awarded to the member’s account.
    Example: "CREDIT"

  - `body.To Award Points.credit` (integer, required)
    Enter the number of points credited to the member’s account for performing the action.
    Example: 435

  - `body.To Award Points.pointType` (string)
    Enter the value for the point type parameter, which specifies the transaction type for credit and debit activities. If the user sets the point type value to “Regular”, it should display as “Regular” in Point API response and overwrite the existing point value in the activity API response. If the point type parameter is included in the Point API payload but no value is provided, the system will throw an error indicating that the point type should not be blank. If the point type is not included, the current behavior is that the point response will not display the point type parameter and it’s value.
    Example: "Standard or Promotional"

  - `body.To Award Points.campaignId` (integer)
    Enter the campaign ID of the campaign associated with the points. (The campaign ID needs to be entered only if the points being awarded are associated with campaign benefits).
    Example: 12345

  - `body.To Award Points.orderId` (string)
    Enter the loyalty member's order ID.
    Example: "A12345"

  - `body.To Award Points.source` (string)
    Enter the source from where the member performed the transaction. For example, Web or App.
    Example: "web"

  - `body.To Award Points.reason` (string)
    Enter the reason for crediting points to the member’s account.
    Example: "bonus"

  - `body.To Award Points.storeId` (string)
    Enter the store ID, a unique number used to identify the specific store. Note - If a store ID is provided with any action and it exists in the metadata, all associated attributes of that store will be displayed. If the store ID does not exist in the metadata, it will simply display the store ID itself.
    Example: "IN12369"

  - `body.To Award Points.actionAttribute` (object)
    Action attributes allow you to capture additional metadata about an action. If you are leveraging action attributes, enter the following data.

  - `body.To Award Points.actionAttribute.attributeValue` (string)
    Enter the attribute name that has been added to the action. This attribute is nested within the action attribute object, where the parameter specifies an attribute name and the parameter value enters the shared metadata.
    Example: "shirt size"

  - `body.To Award or Deduct Custom Points from a member’s account` (object)
    Note - Custom points are not predefined in the system, instead, they are set and managed based on specific user-defined criteria or rules. These points can be awarded or deducted according to custom parameters.

  - `body.To Award or Deduct Custom Points from a member’s account.id` (string, required)
    Enter the unique ID for the member.
    Example: "user@domain.com"

  - `body.To Award or Deduct Custom Points from a member’s account.actionId` (integer, required)
    Enter the unique action ID for which you are awarding or deducting custom points for the member. For example, the action ID for manual credit or debit is 100.
    Example: 100

  - `body.To Award or Deduct Custom Points from a member’s account.activity` (string, required)
    Enter the name of the action to either award or deduct custom points. In this case, the action name is either credit (if awarding) or debit (if deducting).
    Example: "CREDIT or DEBIT"

  - `body.To Award or Deduct Custom Points from a member’s account.source` (string)
    Enter the source from where the member performed the transaction. For example, Web or App.
    Example: "web"

  - `body.To Award or Deduct Custom Points from a member’s account.orderId` (string)
    Enter the loyalty member's order ID. In order to associate points with an activity involving both credit and debit, the member’s order ID needs to be entered.
    Example: "A12345"

  - `body.To Award or Deduct Custom Points from a member’s account.credit or debit` (integer, required)
    Enter the number of custom points that will be credited to the member’s account or debited from the member’s account.
    Example: 435

  - `body.To Award or Deduct Custom Points from a member’s account.Credit[bucketName]` (integer)
    Enter the number of points in this field if you are awarding the member custom points to an additional point bucket. (This is only applicable if the loyalty program leverages multipoint buckets).
    Example: 100

  - `body.To Award or Deduct Custom Points from a member’s account.TierCredit[bucketName]` (integer)
    Enter the number of points if you are awarding the member custom points to an additional tier point bucket. (This is only applicable if the loyalty program leverages multiple point buckets).
    Example: 200

  - `body.To Award or Deduct Custom Points from a member’s account.reason` (string)
    Enter the reason for awarding custom points to the member’s account or deducting custom points from the member’s account.
    Example: "bonus"

  - `body.To Award or Deduct Custom Points from a member’s account.storeId` (string)
    Enter the store ID, a unique number used to identify the specific store. Note - If a store ID is provided with any action and it exists in the metadata, all associated attributes of that store will be displayed. If the store ID does not exist in the metadata, it will simply display the store ID itself.
    Example: "IN12369"

  - `body.To Award or Deduct Custom Points from a member’s account.sectionId` (string)
    Enter the unique survey section ID the custom points are associated with. (A survey includes multiple questions for loyalty members to answer, and the questions are split into various sections to help them comprehend the context of the survey).
    Example: "654"

  - `body.To Award or Deduct Custom Points from a member’s account.sectionName` (string)
    Enter the name of the survey section that the custom points are associated with. (If the member just completes one section of the survey, the name of the survey and the section are both entered).
    Example: "main section"

  - `body.To Award or Deduct Custom Points from a member’s account.surveyId` (string)
    Enter the unique Survey ID that the custom points are associated with. (This identifier helps in tracking and organizing survey responses, ensuring that each response is linked to the correct survey and participant).
    Example: "123"

  - `body.To Award or Deduct Custom Points from a member’s account.surveyName` (string)
    Enter the name of the survey the custom points are associated with. (The surveys for loyalty members have names based on their criteria to differentiate and outline the contents of the survey in brief. If the member takes the survey, the name of the survey in which the member participated is entered).
    Example: "general survey"

  - `body.To Award or Deduct Custom Points from a member’s account.customId` (integer)
    Enter the custom identification number for awarding or deducting the custom points.
    Example: 1022

  - `body.To Award or Deduct Custom Points from a member’s account.actionAttribute` (object)
    Action attributes allow you to capture additional metadata about an action. If you are leveraging action attributes, enter the following data.

  - `body.To Award or Deduct Custom Points from a member’s account.actionAttribute.attributeValue` (string)
    Enter the attribute name that has been added to the action. This attribute is nested within the action attribute object, where the parameter specifies an attribute name and the parameter value enters the shared metadata.
    Example: "shirt size"

  - `body.Transfer Group Points to Members` (object)
    This use case occurs when a member who belongs to a group initiates a point transfer, where the points are debited from the group’s overall balance and credited to an individual member’s account. This type of transfer is commonly referred to as a manual group point transfer. It is triggered using a standard action 176, and the key component that distinguishes this transfer from others is the presence of the groupId in the payload. When the groupId is included, the system understands that the transfer is being made on behalf of the group. The member initiating the action is not transferring points from their own personal balance but instead from the collective balance of the group they are part of. The recipient of these points can be any member within the platform—they may belong to the same group, a different group, or not belong to any group at all. There are no restrictions requiring the recipient to be in the same group as the sender.

  - `body.Transfer Group Points to Members.id` (string, required)
    Enter the unique ID for the member who is transferring their points.
    Example: "user@domain.com"

  - `body.Transfer Group Points to Members.actionId` (integer, required)
    Enter the unique action ID for the action performed by the member. For example, the action ID for transferring points within the group is 160.
    Example: 160

  - `body.Transfer Group Points to Members.groupId` (string)
    Enter the unique ID of the group.
    Example: "91"

  - `body.Transfer Group Points to Members.activity` (string, required)
    Enter debit in the activity field to indicate that the points are being deducted from the member’s account.
    Example: "DEBIT"

  - `body.Transfer Group Points to Members.orderId` (string)
    Enter the loyalty member's order ID.
    Example: "A12345"

  - `body.Transfer Group Points to Members.debit` (integer, required)
    Enter the number of points debited from the member’s account for performing the action.
    Example: 435

  - `body.Transfer Group Points to Members.reason` (string)
    Enter the reason for removing points from the member’s account.
    Example: "points transferred"

  - `body.Transfer Group Points to Members.userId` (string, required)
    Enter the unique user ID of the group member the points should be transferred to.
    Example: "user@domain.com"

  - `body.Transfer Group Points to Members.actionAttribute` (object)
    Action attributes allow you to capture additional metadata about an action. If you are leveraging action attributes, enter the following data.

  - `body.Transfer Group Points to Members.actionAttribute.attributeValue` (string)
    Enter the attribute name that has been added to the action. This attribute is nested within the action attribute object, where the parameter specifies an attribute name and the parameter value enters the shared metadata.
    Example: "moto"

  - `body.Transfer Member Points to Group` (object)
    Note - This only applies if the loyalty program is leveraging hierarchy management groups.

  - `body.Transfer Member Points to Group.id` (string, required)
    Enter the unique ID for the member who is transferring their points.
    Example: "user@domain.com"

  - `body.Transfer Member Points to Group.actionId` (integer, required)
    Enter the unique action ID for the action performed by the member. For example, the action ID for transferring points within the group is 160.
    Example: 160

  - `body.Transfer Member Points to Group.groupId` (string)
    Enter the unique ID of the group.
    Example: "91"

  - `body.Transfer Member Points to Group.activity` (string, required)
    Enter credit in the activity field to indicate that the points are being transferred from a member to the group.
    Example: "CREDIT"

  - `body.Transfer Member Points to Group.debit` (integer, required)
    Enter the number of points debited from the member’s account for performing the action.
    Example: 435

  - `body.Transfer Member Points to Group.reason` (string)
    Enter the reason for transferring the points from the member’s account to the group.
    Example: "points transferred"

  - `body.Transfer Member Points to Group.recipientData` (object)
    Displays details about the recipient

  - `body.Transfer Member Points to Group.recipientData.recipientId` (string)
    Enter the unique ID of the member to whom the points are to be transferred.
    Example: "r00.000@annexcloud.com"

  - `body.Transfer Points between Two Individual Members` (object)
    This use case refers to a straightforward transaction where one member directly transfers points from their personal account to another member’s personal account. Unlike the group transfer scenario, there is no group involvement in this type of transaction. The sender and the recipient are treated as individuals operating independently of any group associations. Although the same action ID (such as 176 or a similar custom action) might be used to trigger both group and individual transfers, the logic used to determine the source of the points (group or personal) depends entirely on the presence or absence of the groupID. In this transfer case, since no groupId is provided, it is understood that both members are acting in their personal capacities. There is no expectation that either member belongs to a group, nor is any group balance affected by this transaction.

  - `body.Transfer Points between Two Individual Members.id` (string, required)
    Enter the unique ID of the member who is transferring their points.
    Example: "user@domain.com"

  - `body.Transfer Points between Two Individual Members.actionId` (integer, required)
    Enter the unique Action ID for the action performed by the member. For example, the custom Action ID for transferring points between two members is 8055.
    Example: 8055

  - `body.Transfer Points between Two Individual Members.activity` (string, required)
    Enter debit in the activity field to indicate that the points are being transferred to the receiver. (This functionality works for debit only)
    Example: "DEBIT"

  - `body.Transfer Points between Two Individual Members.debit` (integer, required)
    Enter the number of points transferred to the receiver’s account on performing the action.
    Example: 435

  - `body.Transfer Points between Two Individual Members.recipientData` (object)
    Enter the following details regarding the receiver.

  - `body.Transfer Points between Two Individual Members.recipientData.recipientId` (string)
    Enter the unique ID of the member to whom the points are to be transferred.
    Example: "r00.000@annexcloud.com"

## Response 200 fields (application/json):

  - `To Redeem Rewards` (object)

  - `To Redeem Rewards.siteId` (string)
    Displays Annex Cloud’s site ID for the loyalty program.
    Example: 99383640

  - `To Redeem Rewards.id` (string)
    Displays the unique ID for the member.
    Example: "user@domain.com"

  - `To Redeem Rewards.rewardId` (integer)
    Displays the specific reward ID associated with the points that the member has redeemed.
    Example: 121

  - `To Redeem Rewards.rewardName` (string)
    Displays the name of the reward.
    Example: "Premium Member Discount"

  - `To Redeem Rewards.rewardCategory` (string)
    Displays the category assigned to the loyalty member's reward, used to differentiate rewards based on various member types or orders.
    Example: "Nee Reward01"

  - `To Redeem Rewards.rewardCategoryId` (integer)
    Displays the unique identifier assigned to each reward category.
    Example: 413

  - `To Redeem Rewards.rewardDescription` (string)
    Displays the description of the reward.
    Example: "Get 25% off your first product purchase."

  - `To Redeem Rewards.rewardTerms` (string)
    Displays the terms of the reward.
    Example: "Points can be redeemed for rewards according to the current redemption schedule. Rewards may include discounts, merchandise, or other specified offers. Rewards are subject to availability and may be changed or discontinued at any time without notice. By participating in the Loyalty Program, you acknowledge that you have read, understood, and agree to abide by these terms and conditions."

  - `To Redeem Rewards.activity` (string)
    Displays debit to indicate points were redeemed.
    Example: "debit"

  - `To Redeem Rewards.orderId` (string)
    Displays the loyalty member's unique order ID.
    Example: "12132ab"

  - `To Redeem Rewards.debit` (integer)
    Displays the number of points debited from the member’s account for redeeming the reward.
    Example: 121

  - `To Redeem Rewards.storeDetails` (object)
    Displays the following store details associated with the store. Note - If a store ID is provided with any action and it exists in the metadata, all associated attributes of that store will be displayed. If the store ID does not exist in the metadata, it will simply display the store ID itself.

  - `To Redeem Rewards.storeDetails.storeId` (string)
    Displays an identifier for the specific store. It is a unique code assigned to each store.
    Example: "IN12369"

  - `To Redeem Rewards.storeDetails.storeName` (string)
    Displays the name associated with the specific store.
    Example: "SHELL"

  - `To Redeem Rewards.storeDetails.storeExtendedAttribute` (string)
    Displays all the store extended attributes.
    Example: "Store Location"

  - `To Redeem Rewards.reason` (string)
    Displays the reason for deducting points from the member’s account.
    Example: "claim"

  - `To Redeem Rewards.customId` (string)
    Displays a unique ID to associate with the Action ID to support unique transactions.
    Example: "gadget01"

  - `To Redeem Rewards.source` (string)
    Displays the source from where the member performed the transaction. For example, Web or App.
    Example: "web"

  - `To Redeem Rewards.pointsDeducted` (integer)
    Displays the number of points deducted from the member’s account for redeeming the reward. (Points deducted refers to the debited points from the available points in the member’s account. This can be configured in the “Points Deduction Behavior” where options like, “Do not Allow Negative Points, Allow Negative Points, and Set Balance to Zero” are available).
    Example: 300

  - `To Redeem Rewards.groupDebit` (integer)
    Displays the total number of points deducted from the group's balance as part of the redemption process. (This field is visible only if the member belongs to a group; otherwise, it will not be included in the response.)
    Example: 20

  - `To Redeem Rewards.groupPointsDeducted` (integer)
    Displays the specific number of points deducted from the member’s point balance. (This field is visible only if the member belongs to a group; otherwise, it will not be included in the response.)
    Example: 20

  - `To Redeem Rewards.rewardCode` (integer)
    Displays the reward code used by the member while redeeming the reward.
    Example: 4260

  - `To Redeem Rewards.rewardCodeExpDate` (string)
    Displays the date on which the reward code will expire in yyyy-MM-dd'T'HH:mm:ssZ format.
    Example: "2020-10-30T05:30:00"

  - `To Redeem Rewards.updatedUserTier` (string)
    Displays the member’s updated tier after points have been redeemed and removed.
    Example: "Gold"

  - `To Redeem Rewards.previousTier` (string)
    Displays the member’s tier prior to point redemption and removal.
    Example: "Silver"

  - `To Redeem Rewards.rewardAttribute` (integer)
    Displays name of the extended reward attribute.  Note - These attributes should be displayed in every reward ID of the configuration.
    Example: "Vat"

  - `To Redeem Rewards.updatedAvailablePoints` (integer)
    Displays the number of points available in the member’s account after points have been redeemed and removed following the redemption of rewards.
    Example: 4545

  - `To Redeem Rewards.updatedLifetimePoints` (integer)
    Displays the updated number of points the member has earned in their lifetime with the loyalty program.
    Example: 7860

  - `To Redeem Rewards.actionAttribute` (object)
    Action attributes allow you to capture additional metadata about an action. Displays the following data if action attributes have been associated with the action.

  - `To Redeem Rewards.actionAttribute.attributeValue` (string)
    Displays the attribute name that has been associated with the action. This attribute is nested within the action attribute object, where the parameter specifies an attribute name and the parameter value enters the shared metadata.
    Example: "shirt size"

  - `To Redeem Rewards.multiBucketsData[bucketName]` (object)
    Displays an array of the additional point buckets where points have been redeemed. (This is only applicable if the loyalty program is leveraging multiple point buckets).

  - `To Redeem Rewards.multiBucketsData[bucketName].debit` (integer)
    Displays the number of points debited from the additional point bucket after the reward was redeemed by the member.
    Example: 100

  - `To Redeem Rewards.multiBucketsData[bucketName].updatedAvailable[bucketName]` (integer)
    Displays the updated number of points available in the additional point bucket after points have been redeemed and removed following the redemption of rewards.
    Example: 200

  - `To Redeem Rewards.multiBucketsData[bucketName].updatedLifetime[bucketName]` (integer)
    Displays the updated number of points the member has earned towards the additional point bucket throughout their lifetime with the loyalty program.
    Example: 300

  - `To Redeem Rewards.tier[bucketName]` (object)
    Displays an array of all multi bucket tier names.

  - `To Redeem Rewards.tier[bucketName].debit` (integer)
    Displays the number of points debited from the member’s account tier bucket after the reward was redeemed.
    Example: 100

  - `To Redeem Rewards.tier[bucketName].updatedAvailableTier[bucketName]` (integer)
    Displays the updated number of available points in the member’s tier bucket after the reward has been redeemed.
    Example: 500

  - `To Redeem Rewards.tier[bucketName].updatedLifetimeTier[bucketName]` (integer)
    Displays the updated number of points the member has earned in the additional tier bucket in their lifetime with the program after the reward has been redeemed.
    Example: 800

  - `To Redeem Custom Points` (object)

  - `To Redeem Custom Points.siteId` (string)
    Displays Annex Cloud’s site ID for the loyalty program.
    Example: 99383640

  - `To Redeem Custom Points.id` (string)
    Displays the unique ID of the member.
    Example: "user@domain.com"

  - `To Redeem Custom Points.actionId` (integer)
    Displays the unique action ID for the redemption of custom points performed by the member.
    Example: 100

  - `To Redeem Custom Points.orderId` (string)
    Displays the loyalty member's unique order ID.
    Example: "12132ab"

  - `To Redeem Custom Points.rewardId` (integer)
    Displays the unique reward ID for the redemption of custom points configured in the loyalty program.
    Example: 12132

  - `To Redeem Custom Points.activity` (string)
    Displays debit to indicate custom points were redeemed.
    Example: "debit"

  - `To Redeem Custom Points.debit` (integer)
    Displays the number of points debited from the member’s account for redeeming custom points by performing the redemption action.
    Example: 500

  - `To Redeem Custom Points.storeDetails` (object)
    Displays the following store details associated with the store. Note - If a store ID is provided with any action and it exists in the metadata, all associated attributes of that store will be displayed. If the store ID does not exist in the metadata, it will simply display the store ID itself.

  - `To Redeem Custom Points.storeDetails.storeId` (string)
    Displays an identifier for the specific store. It is a unique code assigned to each store.
    Example: "IN12369"

  - `To Redeem Custom Points.storeDetails.storeName` (string)
    Displays the name associated with the specific store.
    Example: "SHELL"

  - `To Redeem Custom Points.storeDetails.storeExtendedAttribute` (string)
    Displays all the store extended attributes.
    Example: "Store Location"

  - `To Redeem Custom Points.pointsDeducted` (integer)
    Displays the number of points deducted from the member’s account for redeeming the custom points.(Points deducted refers to the debited points from the available points in the member’s account. This can be configured in the “Points Deduction Behavior” where options like, “Do not Allow Negative Points, Allow Negative Points, and Set Balance to Zero” are available).
    Example: 100

  - `To Redeem Custom Points.reason` (string)
    Displays the reason for removing points from the member’s account upon redeeming custom points.
    Example: "claim"

  - `To Redeem Custom Points.customId` (string)
    Displays a unique ID to associate with the Action ID to support unique transactions.
    Example: "gadget01"

  - `To Redeem Custom Points.source` (string)
    Displays the source from where the member performed the transaction. For example, Web or App.
    Example: "web"

  - `To Redeem Custom Points.campaignId` (integer)
    Displays the campaign ID for the campaign associated with the redeemed points.
    Example: 12132

  - `To Redeem Custom Points.campaignName` (string)
    Displays the name of the campaign associated with the points being redeemed.
    Example: "festival bonanza"

  - `To Redeem Custom Points.campaignPoints` (integer)
    Displays the number of campaign points redeemed from the member’s account.
    Example: 200

  - `To Redeem Custom Points.updatedAvailablePoints` (integer)
    Displays the updated number of available points in the member’s account after redeeming the custom points.
    Example: 900

  - `To Redeem Custom Points.updatedLifetimePoints` (integer)
    Displays the updated number of points the member has earned in their lifetime with the program after redeeming the custom points.
    Example: 1327

  - `To Redeem Custom Points.actionAttribute` (object)
    Action attributes allow you to capture additional metadata about an action. Displays the following data if action attributes have been associated with the action.

  - `To Redeem Custom Points.actionAttribute.attributeValue` (string)
    Displays the attribute name that has been associated with the action. This attribute is nested within the action attribute object, where the parameter specifies an attribute name and the parameter value enters the shared metadata.
    Example: "shirt size"

  - `To Redeem Custom Points.previousTier` (string)
    Displays the member’s tier before redeeming custom points.
    Example: "Silver"

  - `To Redeem Custom Points.updatedUserTier` (string)
    Displays the member’s updated tier after the points are removed for the redemption of custom points.
    Example: "Gold"

  - `To Award Points` (object)

  - `To Award Points.siteId` (string)
    Displays Annex Cloud’s site ID for the loyalty program.
    Example: 99383640

  - `To Award Points.id` (string)
    Displays the unique ID of the member.
    Example: "user@domain.com"

  - `To Award Points.actionId` (integer)
    Displays the unique action ID of the action for which the member is being awarded points.
    Example: 100

  - `To Award Points.orderId` (string)
    Displays the loyalty member's unique order ID.
    Example: "12132ab"

  - `To Award Points.activity` (string)
    Displays credit when points are awarded to the member’s account.
    Example: "credit"

  - `To Award Points.credit` (integer)
    Displays the number of points credited into the member’s account for performing the action.
    Example: 50

  - `To Award Points.storeDetails` (object)
    Displays the following store details associated with the store. Note - If a store ID is provided with any action and it exists in the metadata, all associated attributes of that store will be displayed. If the store ID does not exist in the metadata, it will simply display the store ID itself.

  - `To Award Points.storeDetails.storeId` (string)
    Displays an identifier for the specific store. It is a unique code assigned to each store.
    Example: "IN12369"

  - `To Award Points.storeDetails.storeName` (string)
    Displays the name associated with the specific store.
    Example: "SHELL"

  - `To Award Points.storeDetails.storeExtendedAttribute` (string)
    Displays all the store extended attributes.
    Example: "Store Location"

  - `To Award Points.pointType` (string)
    Displays the value for the point type parameter, which specifies the transaction type for credit and debit activities. For any purchase activity the point type displays as a “standard transaction activity” and if the member receives any campaign benefits or tier benefits, the point type displays as a “promotional activity”.
    Example: "Standard or Promotional"

  - `To Award Points.pointsAwarded` (integer)
    Displays the number of points  awarded to the member’s account for performing the action.
    Example: 50

  - `To Award Points.reason` (string)
    Displays the reason for awarding points to the member’s account.
    Example: "bonus"

  - `To Award Points.customId` (string)
    Displays a unique ID to associate with the Action ID to support unique transactions.
    Example: "id12345"

  - `To Award Points.source` (string)
    Displays the source from where the member performed the transaction. For example, Web or App.
    Example: "web"

  - `To Award Points.updatedUserTier` (string)
    Displays the member’s updated tier after the points are awarded to the member’s account.
    Example: "Gold"

  - `To Award Points.previousTier` (string)
    Displays the member’s previous tier before the points were awarded to the member’s account.
    Example: "Silver"

  - `To Award Points.updatedAvailablePoints` (integer)
    Displays the updated number of available points in the member’s account after points have been awarded.
    Example: 4545

  - `To Award Points.updatedLifetimePoints` (integer)
    Displays the updated total number of points the member has earned in their lifetime with the loyalty program after points have been awarded.
    Example: 7860

  - `To Award Points.actionAttribute` (object)
    Action attributes allow you to capture additional metadata about an action. Displays the following data if action attributes have been associated with the action.

  - `To Award Points.actionAttribute.attributeValue` (string)
    Displays the attribute name that has been associated with the action. This attribute is nested within the action attribute object, where the parameter specifies an attribute name and the parameter value enters the shared metadata.
    Example: "shirt size"

  - `To Award Points.campaignDetails` (object)
    Displays the following information once the campaign milestone benefit activity flag is enabled in the super admin.

  - `To Award Points.campaignDetails.campaignGroupId` (integer)
    Displays the group ID associated with the campaign.
    Example: 1654

  - `To Award Points.campaignDetails.campaignId` (integer)
    Displays the campaign ID.
    Example: 3692

  - `To Award Points.campaignDetails.campaignName` (string)
    Displays the name of the campaign.
    Example: "Back to School Savings"

  - `To Award Points.campaignDetails.campaignPoints` (integer)
    Displays the campaign points awarded to the member once they achieve the campaign milestones.
    Example: 200

  - `To Award Points.campaignDetails.rewardId` (integer)
    Displays the unique ID for the reward configured in the loyalty program.
    Example: 2345

  - `To Award Points.campaignDetails.rewardName` (string)
    Displays the name of the reward used by the member.
    Example: "Jockey $15.00 off purchase"

  - `To Award Points.campaignDetails.rewardCode` (string)
    Displays the reward code used by the member.
    Example: "AP232"

  - `To Award Custom Points` (object)

  - `To Award Custom Points.siteId` (string)
    Displays Annex Cloud’s site ID for the loyalty program.
    Example: 99383640

  - `To Award Custom Points.id` (string)
    Displays the unique ID of the member.
    Example: "user@domain.com"

  - `To Award Custom Points.actionId` (integer)
    Displays the unique action ID for which the member is being awarded custom points.
    Example: 100

  - `To Award Custom Points.orderId` (string)
    Displays the loyalty member's unique order ID.
    Example: "12132ab"

  - `To Award Custom Points.activity` (string)
    Displays credit when custom points are awarded to the member’s account.
    Example: "credit"

  - `To Award Custom Points.credit` (integer)
    Displays the number of custom points credited to the member’s account.
    Example: 50

  - `To Award Custom Points.pointsAwarded` (integer)
    Displays the number of points awarded to the member's account.
    Example: 50

  - `To Award Custom Points.reason` (string)
    Displays the reason for awarding points to the member’s account.
    Example: "bonus"

  - `To Award Custom Points.storeDetails` (object)
    Displays the following store details associated with the store. Note - If a store ID is provided with any action and it exists in the metadata, all associated attributes of that store will be displayed. If the store ID does not exist in the metadata, it will simply display the store ID itself.

  - `To Award Custom Points.storeDetails.storeId` (string)
    Displays an identifier for the specific store. It is a unique code assigned to each store.
    Example: "IN12369"

  - `To Award Custom Points.storeDetails.storeName` (string)
    Displays the name associated with the specific store.
    Example: "SHELL"

  - `To Award Custom Points.storeDetails.storeExtendedAttribute` (string)
    Displays all the store extended attributes.
    Example: "Store Location"

  - `To Award Custom Points.customId` (string)
    Displays a unique ID to associate with the Action ID to support unique transactions.
    Example: "id12345"

  - `To Award Custom Points.sectionId` (string)
    Displays the survey section ID associated with the custom points awarded. (A survey includes multiple questions for loyalty members to answer, and the questions are split into various sections to help them comprehend the context of the survey).
    Example: 654

  - `To Award Custom Points.sectionName` (string)
    Displays the name of the survey section associated with the custom points awarded. (If the member just completes one section of the survey, the name of the survey and the section are both displayed).
    Example: "main section"

  - `To Award Custom Points.surveyId` (string)
    Displays the unique Survey ID associated with the custom points awarded. (This identifier helps in tracking and organizing survey responses, ensuring that each response is linked to the correct survey and participant).
    Example: 123

  - `To Award Custom Points.surveyName` (string)
    Displays the name of the survey associated with the custom points awarded. (The surveys for loyalty members have names based on their criteria to differentiate and outline the contents of the survey in brief. If the member takes the survey, the name of the survey in which the member participated is displayed).
    Example: "general survey"

  - `To Award Custom Points.source` (string)
    Displays the source from where the member performed the transaction. For example, Web or App.
    Example: "web"

  - `To Award Custom Points.campaignId` (integer)
    Displays the campaign ID of the campaign associated with the points (if campaign is applied).
    Example: 12132

  - `To Award Custom Points.campaignName` (string)
    Displays the campaign name associated with the points.
    Example: "festival bonanza"

  - `To Award Custom Points.campaignPoints` (integer)
    Displays the number of campaign points if the campaign benefit is applied.
    Example: 121

  - `To Award Custom Points.updatedUserTier` (string)
    Displays the member’s updated tier after crediting points to their account.
    Example: "Gold"

  - `To Award Custom Points.previousTier` (string)
    Displays the member’s previous tier before the custom points were awarded to their account.
    Example: "Silver"

  - `To Award Custom Points.updatedAvailablePoints` (integer)
    Displays the number of updated available points after the points have been credited to the member’s account.
    Example: 4545

  - `To Award Custom Points.updatedLifetimePoints` (integer)
    Displays the total number of points the member has earned in their lifetime with the loyalty program.
    Example: 7860

  - `To Award Custom Points.actionAttribute` (object)
    Action attributes allow you to capture additional metadata about an action. Displays the following data if action attributes have been associated with the action.

  - `To Award Custom Points.actionAttribute.attributeValue` (string)
    Displays the attribute name that has been associated with the action. This attribute is nested within the action attribute object, where the parameter specifies an attribute name and the parameter value enters the shared metadata.
    Example: "shirt size"

  - `To Award Custom Points.multiBucketsData[bucketName]` (object)
    Displays an array of all multi bucket details with the following fields.

  - `To Award Custom Points.multiBucketsData[bucketName].bucketName` (object)
    Displays an array of all multi bucket names.

  - `To Award Custom Points.multiBucketsData[bucketName].bucketName.credit` (integer)
    Displays the number of custom points credited to the additional point bucket on the member’s account for performing the action.
    Example: 100

  - `To Award Custom Points.multiBucketsData[bucketName].bucketName.ToExpireDate[bucketName]` (string)
    Displays the date on which points will expire in yyyy-MM-dd'T'HH:mm:ssZ format.
    Example: "2020-10-30T05:30:00+0000"

  - `To Award Custom Points.multiBucketsData[bucketName].bucketName.updatedAvailable[bucketName]` (integer)
    Displays the updated number of points available in the additional point bucket after points have been awarded.
    Example: 200

  - `To Award Custom Points.multiBucketsData[bucketName].bucketName.updatedLifetime[bucketName]` (integer)
    Displays the updated number of points the member has earned towards the additional point bucket in their lifetime with the loyalty program.
    Example: 300

  - `To Award Custom Points.tier[bucketName]` (object)
    Displays an array of all multi bucket names.

  - `To Award Custom Points.tier[bucketName].credit` (integer)
    Displays the number of points credited to the member’s account in the tier bucket after the points were awarded.
    Example: 100

  - `To Award Custom Points.tier[bucketName].tier[bucketName]ToExpireDate` (string)
    Displays the date on which the points will expire in the tier bucket date in yyyy-MM-dd'T'HH:mm:ssZ format.
    Example: "2020-10-30T05:30:00+0000"

  - `To Award Custom Points.tier[bucketName].updatedAvailableTier[bucketName]` (integer)
    Displays the updated number of available points in the member’s account after the custom points were awarded.
    Example: 500

  - `To Award Custom Points.tier[bucketName].updatedLifetimeTier[bucketName]` (integer)
    Displays the updated number of points the member has earned towards the tier bucket in their lifetime with the loyalty program after the custom points were awarded.
    Example: 800

  - `To Deduct Custom Points` (object)

  - `To Deduct Custom Points.siteId` (string)
    Displays Annex Cloud’s site ID for the loyalty program.
    Example: 99383640

  - `To Deduct Custom Points.id` (string)
    Displays the unique ID of the member.
    Example: "user@domain.com"

  - `To Deduct Custom Points.actionId` (integer)
    Displays the unique action ID for which custom points are being deducted from the member’s account.
    Example: 100

  - `To Deduct Custom Points.activity` (string)
    Displays debit to indicate custom points were deducted.
    Example: "debit"

  - `To Deduct Custom Points.orderId` (string)
    Displays the loyalty member's unique order ID.
    Example: "12132ab"

  - `To Deduct Custom Points.debit` (integer)
    Displays the number of custom points debited from the member’s account.
    Example: 50

  - `To Deduct Custom Points.storeDetails` (object)
    Displays the following store details associated with the store. Note - If a store ID is provided with any action and it exists in the metadata, all associated attributes of that store will be displayed. If the store ID does not exist in the metadata, it will simply display the store ID itself.

  - `To Deduct Custom Points.storeDetails.storeId` (string)
    Displays an identifier for the specific store. It is a unique code assigned to each store.
    Example: "IN12369"

  - `To Deduct Custom Points.storeDetails.storeName` (string)
    Displays the name associated with the specific store.
    Example: "SHELL"

  - `To Deduct Custom Points.storeDetails.storeExtendedAttribute` (string)
    Displays all the store extended attributes.
    Example: "Store Location"

  - `To Deduct Custom Points.pointsDeducted` (integer)
    Displays the number of points debited from the member’s account for deducting the custom points. (Points deducted refers to the debited points from the available points in the member’s account. This can be configured in the “Points Deduction Behavior” where options like, “Do not Allow Negative Points, Allow Negative Points, and Set Balance to Zero” are available).

  - `To Deduct Custom Points.pointsNotDeducted` (integer)
    Displays the points that have not been debited from the member’s account.
    Example: 50

  - `To Deduct Custom Points.reason` (string)
    Displays the reason for removing points from the member’s account.
    Example: "adjustment"

  - `To Deduct Custom Points.customId` (string)
    Displays a unique ID to associate with the Action ID to support unique transactions.
    Example: "id12345"

  - `To Deduct Custom Points.updatedUserTier` (string)
    Displays the member’s updated tier after deducting the points from their account.
    Example: "Gold"

  - `To Deduct Custom Points.previousTier` (string)
    Displays the member’s previous tier before deducting the points from their account.
    Example: "Silver"

  - `To Deduct Custom Points.updatedAvailablePoints` (integer)
    Displays the number of updated available points after the points have been debited from the member’s account.
    Example: "general survey"

  - `To Deduct Custom Points.updatedLifetimePoints` (integer)
    Displays the total number of points the member has earned in their lifetime with the loyalty program.
    Example: 7860

  - `To Deduct Custom Points.actionAttribute` (object)
    Action attributes allow you to capture additional metadata about an action. Displays the following data if action attributes have been associated with the action.

  - `To Deduct Custom Points.actionAttribute.attributeValue` (string)
    Displays the attribute name that has been associated with the action. This attribute is nested within the action attribute object, where the parameter specifies an attribute name and the parameter value enters the shared metadata.
    Example: "shirt size"

  - `To Deduct Custom Points.multiBucketsData[bucketName]` (object)
    Displays an array of all multi bucket details with the following fields.

  - `To Deduct Custom Points.multiBucketsData[bucketName].bucketName` (object)
    Displays an array of all the multi bucket names.

  - `To Deduct Custom Points.multiBucketsData[bucketName].bucketName.debit` (integer)
    Displays the number of points debited from the additional point bucket.
    Example: 100

  - `To Deduct Custom Points.multiBucketsData[bucketName].bucketName.updatedAvailable[bucketName]` (integer)
    Displays the updated number of points available in the additional point bucket after points have been deducted.
    Example: 200

  - `To Deduct Custom Points.multiBucketsData[bucketName].bucketName.updatedLifetime[bucketName]` (integer)
    Displays the updated number of points the member has earned towards the additional point bucket in their lifetime with the loyalty program.
    Example: 300

  - `To Deduct Custom Points.tier[bucketName]` (object)
    Displays an array of all multi bucket names.

  - `To Deduct Custom Points.tier[bucketName].debit` (integer)
    Displays the number of points debited from the member’s account in the tier bucket.
    Example: 100

  - `To Deduct Custom Points.tier[bucketName].updatedAvailableTier[bucketName]` (integer)
    Displays the updated number of available points in the member’s tier bucket after the points have been deducted.
    Example: 500

  - `To Deduct Custom Points.tier[bucketName].updatedLifetimeTier[bucketName]` (integer)
    Displays the updated number of points the member has earned towards the tier bucket in their lifetime with the loyalty program.
    Example: 800

  - `Transfer Points between Group Members` (object)

  - `Transfer Points between Group Members.siteId` (string)
    Displays Annex Cloud’s site ID for the loyalty program.
    Example: 9991331

  - `Transfer Points between Group Members.id` (string)
    Displays the unique ID of the member.
    Example: "user@domain.com"

  - `Transfer Points between Group Members.activity` (string)
    Displays debit to indicate points were deducted.
    Example: "debit"

  - `Transfer Points between Group Members.debit` (integer)
    Displays the number of points debited from the group member’s account for performing the action.
    Example: 10

  - `Transfer Points between Group Members.pointsDeducted` (integer)
    Displays the number of points deducted from the group member’s account.
    Example: 10

  - `Transfer Points between Group Members.reason` (string)
    Displays the reason for removing points from the group member’s account.
    Example: "claim"

  - `Transfer Points between Group Members.updatedAvailablePoints` (integer)
    Displays the number of points available in the group member’s account after points have been removed.
    Example: 250

  - `Transfer Points between Group Members.updatedLifetimePoints` (integer)
    Displays the updated number of points the group member has earned in their lifetime with the loyalty program.
    Example: 250

  - `Transfer Points between Group Members.previousTier` (string)
    Displays the group member’s tier prior to points being removed.
    Example: "Silver"

  - `Transfer Points between Group Members.updatedUserTier` (string)
    Displays the member’s updated tier after points have been removed.
    Example: "Gold"

  - `Transfer Points between Group Members.actionAttribute` (object)
    Action attributes allow you to capture additional metadata about an action. Displays the following data if action attributes have been associated with the action.

  - `Transfer Points between Group Members.actionAttribute.attributeValue` (string)
    Displays the attribute name that has been associated with the action. This attribute is nested within the action attribute object, where the parameter specifies an attribute name and the parameter value enters the shared metadata.
    Example: "moto"

  - `Transfer Points between Group Members.hierarchy Data` (object)
    Displays the details of Hierarchy data.

  - `Transfer Points between Group Members.hierarchy Data.userId` (string)
    Displays the unique ID of the group member whom the points were transferred to.
    Example: "user@domain.com"

  - `Transfer Points between Group Members.hierarchy Data.activity` (string)
    Displays credit to indicate that the points are credited to the member’s account.
    Example: "credit"

  - `Transfer Points between Group Members.hierarchy Data.credit` (integer)
    Displays the number of points credited to the group member’s account.
    Example: 50

  - `Transfer Member Points to Group` (object)

  - `Transfer Member Points to Group.siteId` (string)
    Displays Annex Cloud’s site ID for the loyalty program.
    Example: 9991331

  - `Transfer Member Points to Group.id` (string)
    Displays the unique ID of the member.
    Example: "user@domain.com"

  - `Transfer Member Points to Group.actionId` (integer)
    Displays the unique action ID for the action performed by the member. For example, the action ID for transferring points within the group is 160.
    Example: 160

  - `Transfer Member Points to Group.activity` (string)
    Displays credit in the activity field to indicate that the points are being transferred from a member to the group.
    Example: "credit"

  - `Transfer Member Points to Group.credit` (integer)
    Displays the number of points credited or transferred from the member’s account when performing the action to credit points to the group.
    Example: 435

  - `Transfer Member Points to Group.pointsAwarded` (integer)
    Displays the number of points  awarded to the group.
    Example: 435

  - `Transfer Member Points to Group.reason` (string)
    Displays  the reason for transferring the points from the member’s account to the group.
    Example: "transfer points to group"

  - `Transfer Member Points to Group.updatedAvailablePoints` (integer)
    Displays the updated number of available points in the member’s account after points have been transferred.
    Example: 200

  - `Transfer Member Points to Group.updatedLifetimePoints` (integer)
    Displays the updated number of points the group member has earned in their lifetime with the loyalty program.
    Example: 250

  - `Transfer Member Points to Group.previousTier` (string)
    Displays the group member’s previous tier before transferring points to group.
    Example: "Silver"

  - `Transfer Member Points to Group.updatedUserTier` (string)
    Displays the group member’s updated tier after transferring the points from their account.
    Example: "Gold"

  - `Transfer Member Points to Group.actionAttribute` (object)
    Action attributes allow you to capture additional metadata about an action. Displays the following data if action attributes have been associated with the action.

  - `Transfer Member Points to Group.actionAttribute.attributeValue` (string)
    Displays the attribute name that has been associated with the action. This attribute is nested within the action attribute object, where the parameter specifies an attribute name and the parameter value enters the shared metadata.
    Example: "moto"

  - `Transfer Member Points to Group.hierarchy Data` (object)
    Displays the details of Hierarchy data.

  - `Transfer Member Points to Group.hierarchy Data.groupId` (string)
    Displays the unique ID of the group within the loyalty program.
    Example: "91"

  - `Transfer Member Points to Group.hierarchy Data.activity` (string)
    Displays credit to indicate that the points are credited to the group.
    Example: "credit"

  - `Transfer Member Points to Group.hierarchy Data.credit` (integer)
    Displays the number of points credited to the group.
    Example: 50

  - `Transfer Member Points to Group.hierarchy Data.groupAvailablePoints` (integer)
    Displays the number of available points in the group after the points have been credited.
    Example: 50

  - `Transfer Member Points to Group.error code` (string)
    Displays only when the API request fails, indicating the type of error.
    Example: "error"

  - `Transfer Member Points to Group.error message` (string)
    Displays the reason why the API request has failed.
    Example: "fail"

  - `Transfer points between two members` (object)

  - `Transfer points between two members.siteId` (string)
    Displays Annex Cloud’s site ID for the loyalty program.
    Example: 9991331

  - `Transfer points between two members.id` (string)
    Displays the unique ID of the loyalty member.
    Example: "user@domain.com"

  - `Transfer points between two members.actionId` (integer)
    Displays the unique Action ID for the action performed by the member. For example, the custom Action ID for transferring points to a member is 8055.
    Example: 8055

  - `Transfer points between two members.activity` (string)
    Displays DEBIT in the activity field to indicate that the points are being transferred to the receiver.
    Example: "debit"

  - `Transfer points between two members.debit` (integer)
    Displays the number of points debited or transferred to the receiver’s account on performing the action.
    Example: 20

  - `Transfer points between two members.pointsDeducted` (integer)
    Displays the number of points deducted from the sender’s account to be transferred to the receiver’s account.
    Example: 20

  - `Transfer points between two members.pointsNotDeducted` (integer)
    Displays the number of points that were not deducted from the sender’s account to be transferred to the receiver’s account but satisfy the conditions set in the UI that make them eligible to be transferred.
    Example: 30

  - `Transfer points between two members.groupDebit` (integer)
    Displays the total number of points deducted from the group's balance when transferring points between two members. (This field is visible only if the sender belongs to a group; otherwise, it will not be included in the response.)
    Example: 20

  - `Transfer points between two members.groupPointsDeducted` (integer)
    Displays the number of points deducted from the sender’s points balance. (This field appears only when the sender is part of a group; otherwise, it will not be displayed in the response.)
    Example: 20

  - `Transfer points between two members.updatedAvailablePoints` (integer)
    Displays the updated number of available points in the sender’s account after points have been transferred.
    Example: 200

  - `Transfer points between two members.reason` (string)
    Displays the reason for transferring the points to the receiver’s account from the sender’s account.
    Example: "transfer points request"

  - `Transfer points between two members.updatedLifetimePoints` (integer)
    Displays the updated number of points the sender has earned in their lifetime with the loyalty program.
    Example: 250

  - `Transfer points between two members.previousTier` (string)
    Displays the sender’s previous tier before transferring points to the receiver.
    Example: "Gold"

  - `Transfer points between two members.updatedUserTier` (string)
    Displays the sender’s updated tier after transferring the points from their account.
    Example: "Silver"

  - `Transfer points between two members.recipientData` (object)
    Displays the following details associated with the receiver of points.

  - `Transfer points between two members.recipientData.recipientId` (string)
    Displays the unique identifier of the member who is receiving the points upon the execution of custom Action ID 8055.
    Example: "r00.00@annexcloud.com"

  - `Transfer points between two members.recipientData.activity` (string)
    Displays the activity being performed due to which the member is sending or receiving the points.
    Example: "credit"

  - `Transfer points between two members.recipientData.credit` (integer)
    Displays the number of points being credited to the receiver's account upon the execution of custom action ID 8055.
    Example: 20

  - `Transfer points between two members.recipientData.campaignId` (integer)
    Displays the campaign ID associated with the actions facilitating the transfer of points between two members.
    Example: 3110

  - `Transfer points between two members.recipientData.groupCredit` (integer)
    Displays the total number of points credited to the recipient's points balance or group balance, depending on the configured settings that allow points to be added to a group balance. This applies when transferring points between two members. (This field is only visible if the recipient belongs to a group; otherwise, it will not be included in the response.)
    Example: 20

  - `Transfer points between two members.recipientData.groupId` (string)
    Displays the specific Group ID that the recipient belongs to. (This field appears only when the recipient is part of a group; otherwise, it will not be displayed in the response.)
    Example: "91"

  - `Transfer points between two members.recipientData.campaignName` (string)
    Displays the campaign name associated with the actions facilitating the transfer of points between two members.
    Example: "PBL-1220 campaign"

  - `Transfer points between two members.recipientData.campaignPoints` (integer)
    Displays the number of points transferred according to the configured conditions.


## Response 400 fields

## Response 403 fields

## Response 404 fields

## Response 405 fields

## Response 422 fields