{"items":[{"type":"group","fsPath":"introduction.md","metadata":{"type":"markdown"},"label":"Annex Cloud","link":"/introduction-1","routeSlug":"/introduction-1","items":[{"type":"group","label":"Customer Loyalty","items":[{"type":"link","label":"Loyalty APIs","link":"/loyalty/loyalty","routeSlug":"/loyalty/loyalty"},{"type":"group","label":"JWT Authentication","link":"/loyalty/loyalty/jwt-authentication","routeSlug":"/loyalty/loyalty/jwt-authentication","items":[]},{"type":"group","label":"Users","link":"/loyalty/loyalty/users","routeSlug":"/loyalty/loyalty/users","items":[{"label":"Used to create a new loyalty member.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/users/createuser","routeSlug":"/loyalty/loyalty/users/createuser","metadata":{"seo":{"title":"Used to create a new loyalty member.","description":"To create new loyalty members and enroll them in the loyalty program, use the POST method in the user API. A unique ID must be specified while creating a new member. All other additional fields in the request and response body are listed below. The Annex Cloud User API uses the Zend Framework’s email validation library to verify email addresses in compliance with RFC 2822. The validation rules are -"}},"httpPath":"/users"},{"label":"Get member information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/users/paths/~1users~1{{memberid}}/get","routeSlug":"/loyalty/loyalty/users/paths/~1users~1{{memberid}}/get","metadata":{"seo":{"title":"Get member information","description":"This API method is used to fetch all the information for a loyalty member by passing the unique ID of the member."}},"httpPath":"/users/{{memberId}}"},{"label":"Update member details","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/users/userupdatereq","routeSlug":"/loyalty/loyalty/users/userupdatereq","metadata":{"seo":{"title":"Update member details","description":"This method is used to update existing member information by merging the provided information with the current data. The Annex Cloud User API uses the Zend Framework’s email validation library to verify email addresses in compliance with RFC 2822. The validation rules are -"}},"httpPath":"/users/{{memberId}}"},{"label":"Delete member","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/users/userdelete","routeSlug":"/loyalty/loyalty/users/userdelete","metadata":{"seo":{"title":"Delete member","description":"This method can be used to delete the member from the loyalty program."}},"httpPath":"/userdelete"},{"label":"Get group information with group ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/users/getgroupdetails","routeSlug":"/loyalty/loyalty/users/getgroupdetails","metadata":{"seo":{"title":"Get group information with group ID","description":"This API is used to retrieve the information of a member associated with a hierarchy management group."}},"httpPath":"/users/{{memberId}}/allgroup"},{"label":"To search member details","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/users/usersearch","routeSlug":"/loyalty/loyalty/users/usersearch","metadata":{"seo":{"title":"To search member details","description":"This API is used to search member details based on multiple query parameters. Note - This API can only return a maximum of 50 records, and customers can access more than 50 user records by using the user export report in the admin portal."}},"httpPath":"/users/search"},{"label":"Merge two members","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/users/mergeuserpost","routeSlug":"/loyalty/loyalty/users/mergeuserpost","metadata":{"seo":{"title":"Merge two members","description":"This method is used to merge two member accounts. The Secondary member account is merged with the Primary member account. Post merge, all the activities on the secondary member account are owned by the primary member. Also, if the primary member is missing member details, these details are filled in by the secondary member's details if available. Note - For 'Multi Template Summary Flag' enabled sites, the response shown below is sent to the email address provided against the mergedBy parameter."}},"httpPath":"/mergeuser"},{"label":"Get the status of the merge process by member’s ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/users/getmergeuser","routeSlug":"/loyalty/loyalty/users/getmergeuser","metadata":{"seo":{"title":"Get the status of the merge process by member’s ID","description":"This method is used to get the details of the primary member after the merge functionality is completed, and only a single member is left (the primary member). It displays how many members have been merged with the primary member, and some basic information, such as who the merge was initiated by and the reason for the merge. Note - For 'Multi Template Summary Flag' enabled sites, the response shows an additional status parameter which indicates whether the merge process is in-progress or completed."}},"httpPath":"/mergeuser/{{memberId}}"},{"label":"Fetch the activity summary by action ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/users/getuseridactivitysummaryactionid","routeSlug":"/loyalty/loyalty/users/getuseridactivitysummaryactionid","metadata":{"seo":{"title":"Fetch the activity summary by action ID","description":"This API retrieves a summary of a member's activity, including points that have been debited or credited."}},"httpPath":"/users/{{memberId}}/activitysummary/{{actionId}}"},{"label":"Used to create multiple loyalty member profiles","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/users/bulkpostusers","routeSlug":"/loyalty/loyalty/users/bulkpostusers","metadata":{"seo":{"title":"Used to create multiple loyalty member profiles","description":"This API method is used for managing large-scale member registrations in the loyalty program. It facilitates the quick and efficient onboarding of multiple loyalty members simultaneously, by allowing the creation of several loyalty member profiles in a single request. This method significantly reduces the time and effort required to populate the loyalty program with new members, enhancing operational efficiency. NOTE - Please ensure that members are added in batches of a maximum of 50 at a time to maintain optimized performance."}},"httpPath":"/bulkpostusers"},{"label":"Used to update multiple loyalty member profiles","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/users/postbulkpatchusers","routeSlug":"/loyalty/loyalty/users/postbulkpatchusers","metadata":{"seo":{"title":"Used to update multiple loyalty member profiles","description":"This endpoint enables updating member information efficiently in bulk. NOTE - We recommend limiting requests to around 100 records.Note: For all date-time fields in the request and response, if the timestamp contains a timezone offset after the + symbol (for example, 2024-07-21T12:30:45+05:30), the value after + will be ignored during processing. Only the date and time portion before the + sign will be considered."}},"httpPath":"/bulkpatchusers"},{"label":"Get transaction erasure details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/users/gettransactionerasure","routeSlug":"/loyalty/loyalty/users/gettransactionerasure","metadata":{"seo":{"title":"Get transaction erasure details","description":"By passing the User ID, use this method to retrieve all transaction erasure details for a loyalty member."}},"httpPath":"/transactionErasure/{{memberId}}"},{"label":"Perform transaction erasure","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/users/posttransactionerasure","routeSlug":"/loyalty/loyalty/users/posttransactionerasure","metadata":{"seo":{"title":"Perform transaction erasure","description":"This method enables the member to perform Transaction Erasure for transactions that meet the predefined conditions."}},"httpPath":"/transactionErasure"},{"label":"Undo transaction erasure","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/users/transactionerasure","routeSlug":"/loyalty/loyalty/users/transactionerasure","metadata":{"seo":{"title":"Undo transaction erasure","description":"Patch method is used to undo the transaction erasure that is in progress and not yet completed."}},"httpPath":"/transactionErasure"},{"label":"Fetch the activity details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/users/getuseractivityreq","routeSlug":"/loyalty/loyalty/users/getuseractivityreq","metadata":{"seo":{"title":"Fetch the activity details","description":"By using this method, all activity details for a member can be retrieved.Note: For all date-time fields in the request and response, if the timestamp contains a timezone offset after the + symbol (for example, 2024-07-21T12:30:45+05:30), the value after + will be ignored during processing. Only the date and time portion before the + sign will be considered."}},"httpPath":"/users/{{memberId}}/activity"}]},{"type":"group","label":"Points","link":"/loyalty/loyalty/points","routeSlug":"/loyalty/loyalty/points","items":[{"label":"To deduct or award loyalty points to multiple members","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/points/postbulkpoints","routeSlug":"/loyalty/loyalty/points/postbulkpoints","metadata":{"seo":{"title":"To deduct or award loyalty points to multiple members","description":"This method allows you to simultaneously deduct or award points to multiple members. To make a bulk point adjustment you will number each object in the request. Nested within each object, you must include the id, actionId, and activity parameters. If you are manually crediting points or debiting points, you must also include the credit or debit parameter accordingly. If you are crediting points for a point awarding action configured in the loyalty program, you do not need to include the credit parameter, as it will award the member points as configured in the system for that action ID."}},"httpPath":"/bulkpoints"},{"label":"To retrieve point details for a member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/points/getpointsid","routeSlug":"/loyalty/loyalty/points/getpointsid","metadata":{"seo":{"title":"To retrieve point details for a member","description":"This method retrieves point details associated with a member’s ID. The member needs to use their ID as a key to fetch all the points details."}},"httpPath":"/points/{{memberId}}"},{"label":"Fetches the point expiration details for a specific member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/points/getpointsexpiryid","routeSlug":"/loyalty/loyalty/points/getpointsexpiryid","metadata":{"seo":{"title":"Fetches the point expiration details for a specific member","description":"This API is used to fetch the point expiration details for a member based on the specified date range and page number as provided by the user."}},"httpPath":"/pointsexpiry/{{memberId}}"},{"label":"To deduct points, redeem points and award loyalty points to a member","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/points/postpoints","routeSlug":"/loyalty/loyalty/points/postpoints","metadata":{"seo":{"title":"To deduct points, redeem points and award loyalty points to a member","description":"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."}},"httpPath":"/points"},{"label":"Retrieves the points details of multiple members.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/points/getbulkpoints","routeSlug":"/loyalty/loyalty/points/getbulkpoints","metadata":{"seo":{"title":"Retrieves the points details of multiple members.","description":"This method retrieves point details associated with multiple members’ IDs. The members need to use their ID as a key to fetch all the points details."}},"httpPath":"/getbulkpoints"}]},{"type":"group","label":"Action","link":"/loyalty/loyalty/action","routeSlug":"/loyalty/loyalty/action","items":[{"label":"Fetch the Action details by User ID","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/action/postactions","routeSlug":"/loyalty/loyalty/action/postactions","metadata":{"seo":{"title":"Fetch the Action details by User ID","description":"This method retrieves all actions configured for the site and indicates which ones the member has completed."}},"httpPath":"/actions"},{"label":"Fetch the details of all actions performed against the site","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/action/getactionstatus","routeSlug":"/loyalty/loyalty/action/getactionstatus","metadata":{"seo":{"title":"Fetch the details of all actions performed against the site","description":"This method retrieves information pertaining to all activities carried out on the site ID. To obtain all actions configured on the site, simply input \"all\" as the status parameter."}},"httpPath":"/actions/{{status}}"},{"label":"Fetch action group details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/action/getactiongrouplistgroupid","routeSlug":"/loyalty/loyalty/action/getactiongrouplistgroupid","metadata":{"seo":{"title":"Fetch action group details","description":"This GET method is utilized to retrieve details associated with the action group by specifying the Action Group ID within the environment."}},"httpPath":"/actiongrouplist/{{actionGroupId}}"},{"label":"Fetch all the active action group details by User ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/action/getactiongroupemailid","routeSlug":"/loyalty/loyalty/action/getactiongroupemailid","metadata":{"seo":{"title":"Fetch all the active action group details by User ID","description":"Upon passing the GET method in the environment, the system retrieves the following information - 1. All enabled action groups for the site. 2. User-associated actions linked to any enabled actions, including earned points, available points to earn, used action IDs, and more."}},"httpPath":"/actiongroup/{{memberId}}"},{"label":"Fetch the details of the action series performed by the member using actionSeriesID","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/action/postactionseries","routeSlug":"/loyalty/loyalty/action/postactionseries","metadata":{"seo":{"title":"Fetch the details of the action series performed by the member using actionSeriesID","description":"Fetch the details of the action series performed by the member using actionSeriesID"}},"httpPath":"/users/{{memberId}}/actionseries"},{"label":"Fetch the details of action series performed by the member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/action/getactionseriesbyemail","routeSlug":"/loyalty/loyalty/action/getactionseriesbyemail","metadata":{"seo":{"title":"Fetch the details of action series performed by the member","description":"This method retrieves the details of all action series performed by the particular member by using email address."}},"httpPath":"/users/{{memberId}}/actionseries"}]},{"type":"group","label":"Activity","link":"/loyalty/loyalty/activity","routeSlug":"/loyalty/loyalty/activity","items":[{"label":"Fetch the activity details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/activity/getactivityqueryreq","routeSlug":"/loyalty/loyalty/activity/getactivityqueryreq","metadata":{"seo":{"title":"Fetch the activity details","description":"This method allows for the retrieval of details about performed activities. The following paths can be utilized to display the activities. Below are a few examples that show how you can combine query parameters -"}},"httpPath":"/users/{{memberId}}/activity/"}]},{"type":"group","label":"Tiers V2","link":"/loyalty/loyalty/tiers-v2","routeSlug":"/loyalty/loyalty/tiers-v2","items":[{"label":"Get all the configured tier programs on a site.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/tiers-v2/gettierprogramall","routeSlug":"/loyalty/loyalty/tiers-v2/gettierprogramall","metadata":{"seo":{"title":"Get all the configured tier programs on a site.","description":"This method allows you to fetch all the configured tier programs on a site. At any given time, a maximum of only ten tier programs can be configured on the site, and only one tier program can go live at a time."}},"httpPath":"/tier/program/{{all}}"},{"label":"Get tier details using the program ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/tiers-v2/gettierprogramprogramid","routeSlug":"/loyalty/loyalty/tiers-v2/gettierprogramprogramid","metadata":{"seo":{"title":"Get tier details using the program ID.","description":"This endpoint retrieves all configuration details for a tier program using the program ID. It includes details such as entry conditions, tier benefits, and additional metadata. The metadata offers further insights about each tier."}},"httpPath":"/tier/program{{program_id}}"},{"label":"Get tier information for a loyalty member.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/tiers-v2/getusersuseridtier","routeSlug":"/loyalty/loyalty/tiers-v2/getusersuseridtier","metadata":{"seo":{"title":"Get tier information for a loyalty member.","description":"This method can be used to get tier information for a member by passing the user ID. It also provides information on tier upgrades, retention, and downgrades."}},"httpPath":"/users/{{user_id}}/tier"},{"label":"Manually assign a tier to a member.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/tiers-v2/posttiertierid","routeSlug":"/loyalty/loyalty/tiers-v2/posttiertierid","metadata":{"seo":{"title":"Manually assign a tier to a member.","description":"This method is used to manually assign a tier to a member, qualifying them for the configured benefits associated with the assigned tier.Note: To manually assign a tier to a member, the \"Enable manual member tier assignment\" flag must be enabled at the site level."}},"httpPath":"/tier/{{tier_id}}"}]},{"type":"group","label":"Tiers(Deprecated)","link":"/loyalty/loyalty/tiers(deprecated)","routeSlug":"/loyalty/loyalty/tiers(deprecated)","items":[{"label":"Tier information against site ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/tiers(deprecated)/getalltierlist","routeSlug":"/loyalty/loyalty/tiers(deprecated)/getalltierlist","metadata":{"seo":{"title":"Tier information against site ID","description":"This method retrieves tier details against site ID. The member must use the site ID as a key to fetch all the details of the Tier."}},"httpPath":"/tierlist/all"},{"label":"Tier information against site ID and page number","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/tiers(deprecated)/getalltierlistpage","routeSlug":"/loyalty/loyalty/tiers(deprecated)/getalltierlistpage","metadata":{"seo":{"title":"Tier information against site ID and page number","description":"This method retrieves tier details against a site ID and page number. Site ID and page number must be passed as a key to fetch all the details of the tiers."}},"httpPath":"/tierlist/all?page=1"},{"label":"Get tier information for a loyalty member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/tiers(deprecated)/gettiersinfo","routeSlug":"/loyalty/loyalty/tiers(deprecated)/gettiersinfo","metadata":{"seo":{"title":"Get tier information for a loyalty member","description":"This method retrieves tier details for a specific member. Enter the member's user ID as a key to fetch all tier details for that member."}},"httpPath":"/users/{{memberId}}/tiers"}]},{"type":"group","label":"Rewards","link":"/loyalty/loyalty/rewards","routeSlug":"/loyalty/loyalty/rewards","items":[{"label":"Fetch the list of all rewards for a member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/rewards/getrewardsbyuser","routeSlug":"/loyalty/loyalty/rewards/getrewardsbyuser","metadata":{"seo":{"title":"Fetch the list of all rewards for a member","description":"This method can be used to retrieve a list of all available rewards against a member ID. The administrator needs to pass a unique member ID as the key to fetch the details. A query parameter rewardSequence can be used to sort reward based on sequence. The response body for this method is the same as the response body for the GET-/users/{{id}}/reward method. GET-/users/{{id}}/reward?sort_by=rewardSequence - This method is used to sort the reward based on sequence."}},"httpPath":"/users/{{memberId}}/reward"},{"label":"Fetch the list of all rewards used by a member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/rewards/getusedreward","routeSlug":"/loyalty/loyalty/rewards/getusedreward","metadata":{"seo":{"title":"Fetch the list of all rewards used by a member","description":"Using this method, you can retrieve the details of all rewards that have been used by a specific loyalty member. To access the rewards, you need to pass the unique member ID."}},"httpPath":"/users/{{memberId}}/usedreward"},{"label":"Debit points from member's account for using a reward","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/rewards/usedrewardpost","routeSlug":"/loyalty/loyalty/rewards/usedrewardpost","metadata":{"seo":{"title":"Debit points from member's account for using a reward","description":"This method is used to debit points from the member's account using their ID, used reward ID and code, and the number of points to be debited."}},"httpPath":"/users/{{memberId}}/usedreward"},{"label":"Fetch the list of all the rewards established in your loyalty program","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/rewards/getrewardsbysite","routeSlug":"/loyalty/loyalty/rewards/getrewardsbysite","metadata":{"seo":{"title":"Fetch the list of all the rewards established in your loyalty program","description":"By using this method, all rewards configured against a site ID can be retrieved. Note - The results of this API can also be filtered by passing the page number in the query parameter /rewardlist/all?page=1"}},"httpPath":"/rewardlist/all"},{"label":"To update reward details","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/rewards/patchrewardlistrewardidre","routeSlug":"/loyalty/loyalty/rewards/patchrewardlistrewardidre","metadata":{"seo":{"title":"To update reward details","description":"This method can be used to update four parameter details - rewardName, overallRewardLimit, creditRequired, and rewardStatus.  Note - To receive a successful response, the request body must include one of the above-mentioned four parameters along with rewardID."}},"httpPath":"rewardlistupdate/{{rewardId}}"}]},{"type":"group","label":"Segment","link":"/loyalty/loyalty/segment","routeSlug":"/loyalty/loyalty/segment","items":[{"label":"Create a new user segment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/segment/createsegment","routeSlug":"/loyalty/loyalty/segment/createsegment","metadata":{"seo":{"title":"Create a new user segment","description":"This API is used to create a new segment of members in the database. The mandatory parameter values are the name of the segment, the defined start date of the segment, and the defined end date of the segment."}},"httpPath":"/segment"},{"label":"This method retrieves segment details for a specific segment ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/segment/eligiblesegment","routeSlug":"/loyalty/loyalty/segment/eligiblesegment","metadata":{"seo":{"title":"This method retrieves segment details for a specific segment ID","description":"This method retrieves segment details for all members who are eligible to be included in an existing segment. The administrator needs to use the segment ID as a key to fetch all the details of that eligible segment."}},"httpPath":"/eligiblesegment/{{segmentId}}"},{"label":"Get the segment details for a specific segment ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/segment/getsegmentid","routeSlug":"/loyalty/loyalty/segment/getsegmentid","metadata":{"seo":{"title":"Get the segment details for a specific segment ID","description":"This method retrieves segment details for a specific segment ID. The user needs to use the segment ID as a key to fetch all the details for that particular segment."}},"httpPath":"/segment/{{segmentId}}"},{"label":"This API is used to update member segment","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/segment/updatesegment","routeSlug":"/loyalty/loyalty/segment/updatesegment","metadata":{"seo":{"title":"This API is used to update member segment","description":"The patch method is used to update existing member segments in the database. An update merges the given request parameters into the current segment. The mandatory parameter values are segment ID, segment name, and time duration for the segment."}},"httpPath":"/segment/{{segmentId}}"},{"label":"This API is used to get all the segments against the site ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/segment/getsegmentliststatus","routeSlug":"/loyalty/loyalty/segment/getsegmentliststatus","metadata":{"seo":{"title":"This API is used to get all the segments against the site ID","description":"This method retrieves details of all segments available against the site ID. The administrator defines the ‘status’ parameter as either ‘all,’ ‘active,’ or ‘inactive’ in order to display a list of all the segments contained within the loyalty program (regardless of status), all the active segments within the program, or all the inactive segments within the program, respectively."}},"httpPath":"/segmentlist/status"},{"label":"Add, override, or delete users in bulk","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/segment/postbulksegment","routeSlug":"/loyalty/loyalty/segment/postbulksegment","metadata":{"seo":{"title":"Add, override, or delete users in bulk","description":"This API is used to add, override, or delete users in bulk in the database. The segment ID, a list of user IDs, and defining the ‘memberUpdate’ parameter as ‘add’, ‘override,’ or ‘delete’ are required to update the existing segments."}},"httpPath":"/bulksegmentupdate"}]},{"type":"group","label":"Campaign","link":"/loyalty/loyalty/campaign","routeSlug":"/loyalty/loyalty/campaign","items":[{"label":"Get campaign details by User ID and either Campaign ID or Campaign Status","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/campaign/postcampaign","routeSlug":"/loyalty/loyalty/campaign/postcampaign","metadata":{"seo":{"title":"Get campaign details by User ID and either Campaign ID or Campaign Status","description":"This API is used to get the campaigns details against the user & campaignID."}},"httpPath":"/campaign"},{"label":"Fetch Campaign Details by Campaign Status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/campaign/getcampaignstatus","routeSlug":"/loyalty/loyalty/campaign/getcampaignstatus","metadata":{"seo":{"title":"Fetch Campaign Details by Campaign Status","description":"This method retrieves campaign details for campaigns based on the Campaign Status. To retrieve details for all campaigns of any status, use campaign status = all"}},"httpPath":"/campaign/{{status}}"},{"label":"Fetch Campaign Details by Campaign ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/campaign/getcampaigncampaignid","routeSlug":"/loyalty/loyalty/campaign/getcampaigncampaignid","metadata":{"seo":{"title":"Fetch Campaign Details by Campaign ID","description":"This method retrieves campaign details for a specific Campaign ID. The user must provide the Campaign ID as a key to fetch all the details of that campaign."}},"httpPath":"/campaign/{{campaignId}}"},{"label":"Fetch Campaign Details for all Campaigns for which a member is eligible","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/campaign/getusersidcampaign","routeSlug":"/loyalty/loyalty/campaign/getusersidcampaign","metadata":{"seo":{"title":"Fetch Campaign Details for all Campaigns for which a member is eligible","description":"This method retrieves all active eligible campaigns for a particular member. The user needs to use a unique user ID as a key to fetch all eligible campaigns for the particular member."}},"httpPath":"/users/{{memberId}}/campaign"},{"label":"Reactivate the campaign to participate in it by using userId and campaignId details","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/campaign/patchcampaignactivation","routeSlug":"/loyalty/loyalty/campaign/patchcampaignactivation","metadata":{"seo":{"title":"Reactivate the campaign to participate in it by using userId and campaignId details","description":"Use this PATCH campaign activation method to reactivate the campaign to participate in it. {Reactivation is required if the member receives individual validity more than one time for a campaign.}"}},"httpPath":"/campaign/activation/{{memberId}}"},{"label":"Activate the campaign to participate in it by using userId and campaignId details","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/campaign/postcampaignactivation","routeSlug":"/loyalty/loyalty/campaign/postcampaignactivation","metadata":{"seo":{"title":"Activate the campaign to participate in it by using userId and campaignId details","description":"Use this POST campaign activation method to let the member activate the campaign to participate in it."}},"httpPath":"/campaign/activation"},{"label":"To set a personalized individual validity period for a member within the general campaign period","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/campaign/postcampaignindividualvalidity","routeSlug":"/loyalty/loyalty/campaign/postcampaignindividualvalidity","metadata":{"seo":{"title":"To set a personalized individual validity period for a member within the general campaign period","description":"Use this POST campaign individual validity method to send individual validity for each target member in bulk."}},"httpPath":"/campaign/individualvalidity"},{"label":"Fetch the Campaign Groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/campaign/getcampaigngroupstatus","routeSlug":"/loyalty/loyalty/campaign/getcampaigngroupstatus","metadata":{"seo":{"title":"Fetch the Campaign Groups","description":"This API method returns the response as per the campaign group status passed, i.e. all, active or inactive."}},"httpPath":"/campaign/group/{{status}}"},{"label":"Fetch details of specific Campaign Group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/campaign/getcampaigngroupcampaigngroupid","routeSlug":"/loyalty/loyalty/campaign/getcampaigngroupcampaigngroupid","metadata":{"seo":{"title":"Fetch details of specific Campaign Group","description":"This method allows users to retrieve detailed information about a campaign group by specifying a unique Campaign Group ID."}},"httpPath":"/campaign/group/{{campaignGroupId}}"}]},{"type":"group","label":"Orders","link":"/loyalty/loyalty/orders","routeSlug":"/loyalty/loyalty/orders","items":[{"label":"Create a New Order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/orders/createorder","routeSlug":"/loyalty/loyalty/orders/createorder","metadata":{"seo":{"title":"Create a New Order","description":"Use the POST method in the Orders API to create a new order made by a member in the loyalty program. Each order has a unique ID and contains all the relevant order data such as the member placing the order, the order total, when the order is placed, discounts applied to the order or when the order ships. All other fields in the request body are listed below. Please note that you must enter required fields such as the ID and user ID parameters."}},"httpPath":"/orders"},{"label":"Create New Orders in Bulk","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/orders/createbulkorder","routeSlug":"/loyalty/loyalty/orders/createbulkorder","metadata":{"seo":{"title":"Create New Orders in Bulk","description":"To create new orders in bulk, use this POST method in the Orders API. When uploading bulk orders, you will input the relevant order information such as the parameters for userId, orderID and orderDetails, for each order being passed. This is very helpful when you need to upload the order information for multiple orders instead of doing it as a single order like you would in the POST /orders method. You must specify the order id, user Id, product id, quantity, and unit price parameters for each order included in the bulk request, as they are mandatory fields."}},"httpPath":"/bulkpostorder"},{"label":"Update an existing order in bulk","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/orders/bulkpatchorder","routeSlug":"/loyalty/loyalty/orders/bulkpatchorder","metadata":{"seo":{"title":"Update an existing order in bulk","description":"Use this endpoint in the Bulk Patch Order API to update details of an already created order in the loyalty program. This method allows updating order level information such as status, product details, quantity, and pricing. It is used when an order has already been created but values such as product quantity, unit price, or order status need correction or updates."}},"httpPath":"/bulkpatchorder"},{"label":"This API is used to get the details of all the secondary member orders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/orders/secondaryuserorders","routeSlug":"/loyalty/loyalty/orders/secondaryuserorders","metadata":{"seo":{"title":"This API is used to get the details of all the secondary member orders","description":"This field will only retrieve the information specific to that member for that order. Otherwise, it will return all secondary member's data."}},"httpPath":"/secondaryuserorders"},{"label":"Get order details","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/orders/postorderdetails","routeSlug":"/loyalty/loyalty/orders/postorderdetails","metadata":{"seo":{"title":"Get order details","description":"This API is used to retrieve all of the details of an order based on either the user ID parameter, the order ID parameter, or both. Please note that if only the userId is entered, all orders placed by that member are returned."}},"httpPath":"/orderdetails"},{"label":"Calculate the potential points of the products which are in the member's cart","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/orders/postcart","routeSlug":"/loyalty/loyalty/orders/postcart","metadata":{"seo":{"title":"Calculate the potential points of the products which are in the member's cart","description":"The potential points a member can earn off of the products in their cart are calculated by using the POST cart API. The Purchase Action must be properly configured before the API can function correctly."}},"httpPath":"/cart"},{"label":"Manually adjust (credit or debit) the spend amount for an order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/orders/postmanuaspend","routeSlug":"/loyalty/loyalty/orders/postmanuaspend","metadata":{"seo":{"title":"Manually adjust (credit or debit) the spend amount for an order","description":"To manually adjust the spend amount of an order, use this POST method. When adjusting the spend amount, locate the specific order using the orderId field and then enter when the adjustment is a credit or debit, the amount credited or debited, which administrator performed the adjustment, and the reason why the manual spend is being adjusted."}},"httpPath":"/manualspend"},{"label":"Update the order","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/orders/updateorder","routeSlug":"/loyalty/loyalty/orders/updateorder","metadata":{"seo":{"title":"Update the order","description":"Use the PATCH method in the Orders API to update the order status of a shipment to the ship, return, or cancel status in the input parameter. Orders can also be updated depending on their status as partial or full ship, partial or full return, and partial or full cancellation of the order. All other fields in the request body are listed below. If you are cancelling, returning, or shipping an order, use the first request/response body schema set. If you are adding a new product or changing the quantity of an existing order, use the second request/response body schema set."}},"httpPath":"/orders/orderid"},{"label":"Add to an exisiting order","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/orders/updateaddexistingorder","routeSlug":"/loyalty/loyalty/orders/updateaddexistingorder","metadata":{"seo":{"title":"Add to an exisiting order","description":"Use the following request body schema to add new quantities or an additional product(s) to an existing order by entering add as the Status parameter value."}},"httpPath":"/orders/orderid - Add to an existing order"}]},{"type":"group","label":"BlockList","link":"/loyalty/loyalty/blocklist","routeSlug":"/loyalty/loyalty/blocklist","items":[{"label":"Add domains and members to the blocklist","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/blocklist/blocklist","routeSlug":"/loyalty/loyalty/blocklist/blocklist","metadata":{"seo":{"title":"Add domains and members to the blocklist","description":"This API method is used to block both members and domains within the Annex Cloud site. It facilitates the execution of actions that prevent specified members and domains from accessing or interacting with the site, contributing to enhanced security and control measures."}},"httpPath":"/blocklist"},{"label":"Fetch all blocklist domain and member information for the site","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/blocklist/blocklistall","routeSlug":"/loyalty/loyalty/blocklist/blocklistall","metadata":{"seo":{"title":"Fetch all blocklist domain and member information for the site","description":"This API method retrieves comprehensive information about all the members and domains listed in the blocklist on the Annex Cloud site."}},"httpPath":"/blocklist/all"},{"label":"Delete members and domains from the blocklist","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/blocklist/blocklistdelete","routeSlug":"/loyalty/loyalty/blocklist/blocklistdelete","metadata":{"seo":{"title":"Delete members and domains from the blocklist","description":"This API method is used for removing members and domains from the blocklist of the Annex Cloud site. If members or domains are requested to be deleted but are not on the blocklist, you will be notified in the API response."}},"httpPath":"/blocklistdelete"}]},{"type":"group","label":"Product","link":"/loyalty/loyalty/product","routeSlug":"/loyalty/loyalty/product","items":[{"label":"Get Product Details, Create New Products, Calculate Product Points","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/product/productcreatenew","routeSlug":"/loyalty/loyalty/product/productcreatenew","metadata":{"seo":{"title":"Get Product Details, Create New Products, Calculate Product Points","description":"Use the POST:/products method to get details of the products in the loyalty program. All fields in the response body are listed below. Although this is a POST method, the method performs a GET action and returns details of the specified products."}},"httpPath":"/products"},{"label":"Add New Products in Bulk","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/product/createbulkproducts","routeSlug":"/loyalty/loyalty/product/createbulkproducts","metadata":{"seo":{"title":"Add New Products in Bulk","description":"Use the POST:/bulkproducts method to efficiently add several new products into a loyalty program's product catalog in one operation. When making a bulk request it is required to include the parameters for each product within a numbered object. For each product in the bulk request, you must include the Product Award Type, Product ID, and Category ID."}},"httpPath":"/bulkproducts"},{"label":"Retrieve product information for a specific product","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/product/getproductinfo","routeSlug":"/loyalty/loyalty/product/getproductinfo","metadata":{"seo":{"title":"Retrieve product information for a specific product","description":"This method retrieves product details for a specific product ID. User needs to use product ID as a key to fetch all the details of that particular product."}},"httpPath":"/products/{{prod_id}}"},{"label":"Update Existing Product Information","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/product/updateproduct","routeSlug":"/loyalty/loyalty/product/updateproduct","metadata":{"seo":{"title":"Update Existing Product Information","description":"The PATCH method is used for updates of existing product information. The Point Award Type and Product ID must be specified to update product information. If you enter a different value for any of these fields, the database is updated with the new value. If you enter the existing value for any of these fields, the database is not changed. If you do not include certain fields in the request, or if you do not enter a value for these fields, the database is not updated. You must provide either a Product ID or Category ID in your request. You do not have to provide both. If you provide a Product ID in the request without providing a Category ID, the API displays details of the specified product. If you provide a Category ID in the request, the API displays details for all products in the category. If you provide both a Product ID and a Category ID, the API displays details for all products in the category."}},"httpPath":"/products/{{prod_id}}"},{"label":"Update Products in Bulk","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/product/postbulkpatchproducts","routeSlug":"/loyalty/loyalty/product/postbulkpatchproducts","metadata":{"seo":{"title":"Update Products in Bulk","description":"To update a several products at once in the loyalty program, use this POST method. Points Award Type, Product ID must be specified when updating multiple products. All other additional fields in the request body are listed below. If you enter a different value for any of these fields, the database is updated with the new value. If you enter the existing value for any of these fields, the database is not changed. If you do not include certain fields in the request, or if you do not enter a value for these fields, the database is not updated. You must provide either a Product ID or Category ID in your request. You do not have to provide both. If you provide a Product ID in the request without providing a Category ID, the API displays details of the specified product. If you provide a Category ID in the request, the API displays details for all products in the category. If you provide both a Product ID and a Category ID, the API displays details for all products in the category."}},"httpPath":"/bulkpatchproducts"}]},{"type":"group","label":"Others","link":"/loyalty/loyalty/others","routeSlug":"/loyalty/loyalty/others","items":[{"label":"Get Site Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/others/getsitedetails","routeSlug":"/loyalty/loyalty/others/getsitedetails","metadata":{"seo":{"title":"Get Site Details","description":"This method retrieves the details for the Annex Cloud site. The administrator must use the site ID to fetch the details for the site."}},"httpPath":"/sitedetails/{{siteId}}"}]},{"type":"group","label":"Survey","link":"/loyalty/loyalty/survey","routeSlug":"/loyalty/loyalty/survey","items":[{"label":"This method is used to submit a response to questions in the survey","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/survey/postsurvey","routeSlug":"/loyalty/loyalty/survey/postsurvey","metadata":{"seo":{"title":"This method is used to submit a response to questions in the survey","description":"This method can be used in three different ways to submit a response to questions in the survey. Please see the information listed below to identify your use case."}},"httpPath":"/survey"},{"label":"Get details of all the surveys","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/survey/getsurveyall","routeSlug":"/loyalty/loyalty/survey/getsurveyall","metadata":{"seo":{"title":"Get details of all the surveys","description":"By using this method, all surveys configured against a site ID can be retrieved."}},"httpPath":"/survey/all"},{"label":"Get survey details by survey ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/survey/getsurveysueveyid","routeSlug":"/loyalty/loyalty/survey/getsurveysueveyid","metadata":{"seo":{"title":"Get survey details by survey ID","description":"This method is used to get the survey information for a specific survey by passing the survey ID."}},"httpPath":"/survey/{{surveyId}}"},{"label":"Get survey details by user ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/survey/getsurveyalluseremailid","routeSlug":"/loyalty/loyalty/survey/getsurveyalluseremailid","metadata":{"seo":{"title":"Get survey details by user ID","description":"By passing the user ID, you can retrieve information for all surveys configured for the site and the specific member’s eligibility and completion status for each survey."}},"httpPath":"/survey/all/user/{{memberId}}"},{"label":"Get survey details by survey ID and user ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/survey/getsurveysurveyiduseremailid","routeSlug":"/loyalty/loyalty/survey/getsurveysurveyiduseremailid","metadata":{"seo":{"title":"Get survey details by survey ID and user ID","description":"By passing the survey ID and user ID, information can be retrieved for a specific survey as well as a specific member’s eligibility and completion status for that survey."}},"httpPath":"/survey/{{surveyId}}/user/{{memberId}}"},{"label":"Get section details by section all","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/survey/getsurveysurveyiduseremailidsectionall","routeSlug":"/loyalty/loyalty/survey/getsurveysurveyiduseremailidsectionall","metadata":{"seo":{"title":"Get section details by section all","description":"This method is used to fetch section information for a specific survey along with a specific member’s completion and eligibility status for the survey by passing the survey ID and user ID."}},"httpPath":"/survey/{{surveyId}}/user/{{memberId}}/section/all"},{"label":"Get section details by section ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/survey/getsurveysurveyiduseremailidsectionsectionid","routeSlug":"/loyalty/loyalty/survey/getsurveysurveyiduseremailidsectionsectionid","metadata":{"seo":{"title":"Get section details by section ID","description":"By passing the section ID along with the survey and user ID, this method is used to fetch information for a specific section of a survey along with a specific member’s completion and eligibility status for the survey."}},"httpPath":"/survey/{{surveyId}}/user/{{memberId}}/section/{{sectionId}}"},{"label":"Get question details - Question All","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/survey/getsurveysurveyiduseremailidsectionsectionidquestionall","routeSlug":"/loyalty/loyalty/survey/getsurveysurveyiduseremailidsectionsectionidquestionall","metadata":{"seo":{"title":"Get question details - Question All","description":"This method is used to fetch the question details for a specific section of a survey along with a member’s completion and eligibility status for the survey."}},"httpPath":"/survey/{{surveyId}}/user/{{memberId}}/section/{{sectionId}}/question/all"},{"label":"Get question details by question ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/survey/getsurveysurveyiduseremailidsectionsectionidquestionquestionid","routeSlug":"/loyalty/loyalty/survey/getsurveysurveyiduseremailidsectionsectionidquestionquestionid","metadata":{"seo":{"title":"Get question details by question ID","description":"This method is used to fetch the question details for a specific question within a section of a survey along with a member’s completion and eligibility status for the survey."}},"httpPath":"/survey/{{surveyId}}/user/{{memberId}}/section/{{sectionId}}/question/{{questionId}}"},{"label":"Get survey status by survey and user ID’s","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/survey/getsurveysurveyiduseremailidstatus","routeSlug":"/loyalty/loyalty/survey/getsurveysurveyiduseremailidstatus","metadata":{"seo":{"title":"Get survey status by survey and user ID’s","description":"This method is used to fetch information related to a specific member’s completion of a specific survey."}},"httpPath":"/survey/{{surveyId}}/user/{{memberId}}/status"},{"label":"Get section's completion status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/survey/getsurveysurveyiduseremailidsectionsectionidstatus","routeSlug":"/loyalty/loyalty/survey/getsurveysurveyiduseremailidsectionsectionidstatus","metadata":{"seo":{"title":"Get section's completion status","description":"This method is used to fetch information related to a specific member’s completion of a section within a survey."}},"httpPath":"/survey/{{surveyId}}/user/{{memberId}}/section/{{sectionId}}/status"}]},{"type":"group","label":"Store","link":"/loyalty/loyalty/store","routeSlug":"/loyalty/loyalty/store","items":[{"label":"Get store details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/store/getstore","routeSlug":"/loyalty/loyalty/store/getstore","metadata":{"seo":{"title":"Get store details","description":"This method retrieves detailed information about a store. The administrator must use the store ID to fetch the details for the store."}},"httpPath":"/store/{{Store_Id}}"},{"label":"Create stores in bulk","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/store/bulkpoststores","routeSlug":"/loyalty/loyalty/store/bulkpoststores","metadata":{"seo":{"title":"Create stores in bulk","description":"This method is used to create stores in bulk, which enhances the process and saves member's time. If you pass the same store ID multiple times, it will show an error, and you will not be able to create the required store."}},"httpPath":"/bulkpoststore"},{"label":"Update stores information in bulk","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/store/bulkpatchstores","routeSlug":"/loyalty/loyalty/store/bulkpatchstores","metadata":{"seo":{"title":"Update stores information in bulk","description":"This method is utilized to update store information, such as the name value and its attribute values, in bulk, which saves a lot of processing time for the user. Once a StoreId is created, it cannot be updated. However, you can update the store name value and attribute value using this API."}},"httpPath":"/bulkpatchstore"}]},{"type":"group","label":"Hierarchy Management","link":"/loyalty/loyalty/hierarchy-management","routeSlug":"/loyalty/loyalty/hierarchy-management","items":[{"label":"Create group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/hierarchy-management/postgrouphm","routeSlug":"/loyalty/loyalty/hierarchy-management/postgrouphm","metadata":{"seo":{"title":"Create group","description":"This method is used to create a group and add members to the group. The loyalty member who creates the group automatically becomes the group owner. Note - When the Group Invitation Acceptance Required flag is turned ON, the response body includes invitedBy and invitationStatus in place of the status parameter."}},"httpPath":"/group - HM"},{"label":"Get group information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/hierarchy-management/getgroupgroupifhm","routeSlug":"/loyalty/loyalty/hierarchy-management/getgroupgroupifhm","metadata":{"seo":{"title":"Get group information","description":"This method is used to get group information by passing the unique group ID."}},"httpPath":"/group/{{groupId}} - HM"},{"label":"Update group details or dissolve group","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/hierarchy-management/patchgroupgroupidhm","routeSlug":"/loyalty/loyalty/hierarchy-management/patchgroupgroupidhm","metadata":{"seo":{"title":"Update group details or dissolve group","description":"This method is used to update the group details. This method can also be used to dissolve a group."}},"httpPath":"/group/{{groupId}} - HM"},{"label":"Get invite details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/hierarchy-management/getgroupinviteemailidhm","routeSlug":"/loyalty/loyalty/hierarchy-management/getgroupinviteemailidhm","metadata":{"seo":{"title":"Get invite details","description":"This method is used to retrieve the invitation details for a loyalty member. Members can only belong to one group at a time but can receive multiple group invites before accepting."}},"httpPath":"/group/invite/{{memberId}} - HM"},{"label":"Accept or Decline group invitation","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/hierarchy-management/patchgroupinviteemailidhm","routeSlug":"/loyalty/loyalty/hierarchy-management/patchgroupinviteemailidhm","metadata":{"seo":{"title":"Accept or Decline group invitation","description":"This method is used for accepting or declining group invitations by the loyalty member. Note - The group acceptance criteria only works when the Group Invitation Acceptance Required flag is enabled at the site level."}},"httpPath":"/group/invite/{{memberId}} - HM"},{"label":"Send group invitations / Add members to the group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/hierarchy-management/postgroupinvitehm","routeSlug":"/loyalty/loyalty/hierarchy-management/postgroupinvitehm","metadata":{"seo":{"title":"Send group invitations / Add members to the group","description":"This method is used to send invitations to loyalty members if invites are required. If invitations are not required, this method is used to directly add members to a group."}},"httpPath":"/group/invite - HM"},{"label":"Leave the group","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/hierarchy-management/patchgroupleaveemailidhm","routeSlug":"/loyalty/loyalty/hierarchy-management/patchgroupleaveemailidhm","metadata":{"seo":{"title":"Leave the group","description":"This method allows group members to leave the group. If the \"Restrict Members from Leaving Group\" flag is enabled at site level, members are not permitted to leave the group without the group owner's permission. This method can then be used for a group owner to approve or reject a request to leave."}},"httpPath":"/group/leave/{{memberId}} - HM"},{"label":"Remove a member from the group","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/hierarchy-management/putgroupremoveemailidhm","routeSlug":"/loyalty/loyalty/hierarchy-management/putgroupremoveemailidhm","metadata":{"seo":{"title":"Remove a member from the group","description":"This method is used for removing a group member from the group."}},"httpPath":"/group/remove/{{memberId}} - HM"},{"label":"Update Member Role","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/hierarchy-management/patchgrouproleemailidhm","routeSlug":"/loyalty/loyalty/hierarchy-management/patchgrouproleemailidhm","metadata":{"seo":{"title":"Update Member Role","description":"This method is used to update the member's role. The group owner has the authority to update the member's role."}},"httpPath":"/group/role/{{memberId}} - HM"},{"label":"Get group activity details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/hierarchy-management/getgroupgroupidactivityhm","routeSlug":"/loyalty/loyalty/hierarchy-management/getgroupgroupidactivityhm","metadata":{"seo":{"title":"Get group activity details","description":"This method is used to get the activity details of the group by passing unique group ID."}},"httpPath":"/group/{{groupId}}/activity - HM"},{"label":"Fetches the point expiration details for a specific group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/hierarchy-management/getpointsexpirygroupgrupidhm","routeSlug":"/loyalty/loyalty/hierarchy-management/getpointsexpirygroupgrupidhm","metadata":{"seo":{"title":"Fetches the point expiration details for a specific group","description":"This API retrieves point expiration details for a specified group based on the provided group ID, date range, and page number. Users can group results by week, month, quarter, or year using the aggregate_by parameter. The response includes both expired points and points set to expire within the aggregation period."}},"httpPath":"/pointsexpiry/group/{{groupId}} - HM"}]},{"type":"group","label":"Issuance","link":"/loyalty/loyalty/issuance","routeSlug":"/loyalty/loyalty/issuance","items":[{"label":"Create a new issuance","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/issuance/postissuance","routeSlug":"/loyalty/loyalty/issuance/postissuance","metadata":{"seo":{"title":"Create a new issuance","description":"Use the POST method in the Issuance API to create a new order initiated by a member within the loyalty program. Each order is assigned a unique ID and encompasses essential order details, including the member initiating the order, the total amount of the order, the order placement timestamp, any discounts applied to the order, the shipping timestamp, and other pertinent information. The remaining fields in the request body are detailed below."}},"httpPath":"/issuance- create new issuance"},{"label":"Issuance Creation for Non-Purchase Transactions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/issuance/postissuancecreationfornonpurchasetransactions","routeSlug":"/loyalty/loyalty/issuance/postissuancecreationfornonpurchasetransactions","metadata":{"seo":{"title":"Issuance Creation for Non-Purchase Transactions","description":"Use the POST method in the Issuance API to create a new Non-Purchase Transactions within the loyalty program. Each order has a unique ID and includes essential details like the member, total amount, order timestamp, discounts, shipping timestamp, and other relevant info. Include mandatory fields like order ID and user ID parameters."}},"httpPath":"/issuance- Issuance creation for non purchase transaction"},{"label":"Updated Issuance return","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/issuance/patchupdatedissuancereturn","routeSlug":"/loyalty/loyalty/issuance/patchupdatedissuancereturn","metadata":{"seo":{"title":"Updated Issuance return","description":"Use a PATCH method for updating the status of an existing order, enabling actions such as RETURN, PARTIAL RETURN. Utilize the PATCH method within the Issuance API to modify the order status of a shipment to return status as specified in the input parameter."}},"httpPath":"/issuance- Updated Issuance return"},{"label":"Update the Issuance details","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/issuance/putupdateissuancedetails","routeSlug":"/loyalty/loyalty/issuance/putupdateissuancedetails","metadata":{"seo":{"title":"Update the Issuance details","description":"Use PUT method to edit and update the existing transactional details."}},"httpPath":"/issuance- Update the Issuance details"},{"label":"Update the transaction as Partial Ship","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/issuance/patchupdatetransactionaspartialship","routeSlug":"/loyalty/loyalty/issuance/patchupdatetransactionaspartialship","metadata":{"seo":{"title":"Update the transaction as Partial Ship","description":"Use the PATCH method in the Issuance API to modify the order status of a shipment to \"Partial Ship.\" Orders have the option to be adjusted to Partial Ship status, with all other fields specified in the request body."}},"httpPath":"/issuance- Update the transaction as Partial Ship"},{"label":"Update transaction as Partial Cancel","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/issuance/patchupdatetransactionaspartialcancel","routeSlug":"/loyalty/loyalty/issuance/patchupdatetransactionaspartialcancel","metadata":{"seo":{"title":"Update transaction as Partial Cancel","description":"Use the PATCH method in the Issuance API to modify the order status of a shipment to \"Partial Cancel.\" Orders have the option to be adjusted to Partial Cancel status, with all other fields specified in the request body."}},"httpPath":"/issuance- Update transaction as Partial Cancel"},{"label":"Use Issuance details filter","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/issuance/postissuancedetailsfilter","routeSlug":"/loyalty/loyalty/issuance/postissuancedetailsfilter","metadata":{"seo":{"title":"Use Issuance details filter","description":"Use the POST method to filter the issuance details."}},"httpPath":"/issuancedetails/{{memberId}}"},{"label":"Update the transaction as Full cancel","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/issuance/patchupdatetransactionasfullcancel","routeSlug":"/loyalty/loyalty/issuance/patchupdatetransactionasfullcancel","metadata":{"seo":{"title":"Update the transaction as Full cancel","description":"Use the PATCH method in the Issuance API to modify the order status of a shipment to \"Full Cancel\". Orders have the option to be updated as \"Full Cancel\", while all other fields are specified in the request body."}},"httpPath":"/issuance- Update the transaction as Full Cancel"},{"label":"Update the transaction as Full ship","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/issuance/patchupdatetransactionasfullship","routeSlug":"/loyalty/loyalty/issuance/patchupdatetransactionasfullship","metadata":{"seo":{"title":"Update the transaction as Full ship","description":"Use the PATCH method in the Issuance API to update the order status of a shipment to Full Ship. Orders can be updated as Ship. All other fields are listed in the request body."}},"httpPath":"/issuance- Update the transaction as Full Ship"}]},{"type":"group","label":"Receipt","link":"/loyalty/loyalty/receipt","routeSlug":"/loyalty/loyalty/receipt","items":[{"label":"Upload a receipt","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/receipt/postreceipts","routeSlug":"/loyalty/loyalty/receipt/postreceipts","metadata":{"seo":{"title":"Upload a receipt","description":"This endpoint can be used to upload receipts in JPEG, PNG, or HEIC format. Once a receipt is submitted, it goes through a verification process, and upon successful verification, points are awarded to the member. Here, in the request body, you need to select 'form-data' to provide the user ID and upload the receipt."}},"httpPath":"/receipts - upload receipt"},{"label":"Upload the receipt by providing the URL","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/receipt/postreceiptsurl","routeSlug":"/loyalty/loyalty/receipt/postreceiptsurl","metadata":{"seo":{"title":"Upload the receipt by providing the URL","description":"This endpoint can be used to upload a receipt by providing a URL with a PNG, JPEG, or HEIC extension. Once the receipt is submitted, it goes through a verification process, and upon successful verification, points are awarded to the member. Here, in the request body, you need to select 'raw' to provide the user ID and upload the receipt URL."}},"httpPath":"/receipts - upload receipt by URL"},{"label":"Get member’s receipt details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/receipt/getmemberreceiptdetails","routeSlug":"/loyalty/loyalty/receipt/getmemberreceiptdetails","metadata":{"seo":{"title":"Get member’s receipt details","description":"This endpoint can be used to fetch all receipts uploaded by a member by providing the member's user ID. Note - The member’s receipt information can also be filtered based on query parameters such as receipt_id, receipt_status, and submission_id."}},"httpPath":"/receipts/user/{{email_id}}"},{"label":"Check receipt status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/receipt/getreceiptssubmissionid","routeSlug":"/loyalty/loyalty/receipt/getreceiptssubmissionid","metadata":{"seo":{"title":"Check receipt status","description":"This endpoint can be used to check the status of a receipt after it has been uploaded. Once the receipt is verified, the member receives the points benefit."}},"httpPath":"/receipts/{{submission_id}}"},{"label":"Retrieve the full receipt history for a member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/receipt/paths/~1receipthistory{{email_id}}/get","routeSlug":"/loyalty/loyalty/receipt/paths/~1receipthistory{{email_id}}/get","metadata":{"seo":{"title":"Retrieve the full receipt history for a member","description":"This endpoint can be used to return the full history of all receipts uploaded by a member by providing the member's email address. The image URL for each uploaded receipt is included in the response."}},"httpPath":"/receipthistory{{email_id}}"}]},{"type":"group","label":"Badges","link":"/loyalty/loyalty/badges","routeSlug":"/loyalty/loyalty/badges","items":[{"label":"Retrieve All Badges","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/badges/getallbadges","routeSlug":"/loyalty/loyalty/badges/getallbadges","metadata":{"seo":{"title":"Retrieve All Badges","description":"This method retrieves the complete list of all badges available for a specified site. It provides detailed information about each badge, including its properties, availability status, images associated with various statuses, and configuration attributes. Businesses can use this endpoint to manage badges effectively and understand how they are applied to members within their platform."}},"httpPath":"/badges"},{"label":"Retrieve Member-Specific Badges","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/badges/getmemberbadges","routeSlug":"/loyalty/loyalty/badges/getmemberbadges","metadata":{"seo":{"title":"Retrieve Member-Specific Badges","description":"This endpoint retrieves a list of badges specifically associated with a member identified by their emailId.  It provides detailed information about each badge, such as the badge's name, status, group, and the member's progress.  This is useful for tracking member achievements, managing badge-related rewards, and displaying member-specific badge data in applications."}},"httpPath":"/users/{member_id}/badges"},{"label":"Assign a badge to member","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/badges/postassignbadge","routeSlug":"/loyalty/loyalty/badges/postassignbadge","metadata":{"seo":{"title":"Assign a badge to member","description":"This endpoint allows the assignment of a badge to a specific member identified by their email ID. Businesses can use this functionality to recognize member achievements, milestones, or participation in specific campaigns or events. The request includes detailed information about the badge, member, and contextual data, ensuring proper attribution and traceability."}},"httpPath":"/badges/{badge_id}/users/{member_id}/assign"}]},{"type":"group","label":"Rewards V2","link":"/loyalty/loyalty/rewards-v2","routeSlug":"/loyalty/loyalty/rewards-v2","items":[{"label":"Retrieve a list of all rewards","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/rewards-v2/getrewards","routeSlug":"/loyalty/loyalty/rewards-v2/getrewards","metadata":{"seo":{"title":"Retrieve a list of all rewards","description":"This endpoint retrieves a list of all available rewards. It allows businesses to filter rewards based on various parameters such as type, status, and issuance source type. The response includes metadata about the rewards, such as pagination information and total counts, making it easier for applications to manage large datasets."}},"httpPath":"/rewards"},{"label":"Upload the coupon codes to an active reward","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/rewards-v2/rewardrewardidcoupon","routeSlug":"/loyalty/loyalty/rewards-v2/rewardrewardidcoupon","metadata":{"seo":{"title":"Upload the coupon codes to an active reward","description":"This method uploads one or more coupon codes to the specified active reward. It supports bulk uploads of up to 5,000 codes per request. The system validates each code and returns the overall upload status."}},"httpPath":"/rewards/{{reward_id}}/coupons"},{"label":"Get details of a specific reward","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/rewards-v2/getrewardsrewardid","routeSlug":"/loyalty/loyalty/rewards-v2/getrewardsrewardid","metadata":{"seo":{"title":"Get details of a specific reward","description":"By specifying a unique reward ID, this endpoint provides detailed information about a particular reward. This includes attributes like name, type, status, and redemption data. Businesses can use this information to display or manage specific rewards within their applications, ensuring members have access to the most relevant details."}},"httpPath":"/rewards/{{reward_id}}"},{"label":"Retrieve list of eligible rewards for a member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/rewards-v2/getusersmemberidrewards","routeSlug":"/loyalty/loyalty/rewards-v2/getusersmemberidrewards","metadata":{"seo":{"title":"Retrieve list of eligible rewards for a member","description":"This endpoint retrieves a list of rewards associated with a specific user, identified by the member ID. The response includes reward details, eligibility information, and pagination metadata. This endpoint checks and retrieves the eligibility status of rewards for a specific member, identified by their member ID. It determines whether the member qualifies for any available rewards based on predefined criteria such as past transactions, membership status, or other eligibility rules If no rewards are available, the response will indicate ineligibility."}},"httpPath":"/users/{{member_id}}/rewards"},{"label":"Retrieve history of redeemed rewards for a member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/rewards-v2/getusersmemberidrewardshistory","routeSlug":"/loyalty/loyalty/rewards-v2/getusersmemberidrewardshistory","metadata":{"seo":{"title":"Retrieve history of redeemed rewards for a member","description":"This endpoint allows you to retrieve and filter rewards associated with a specific member identified by their Member ID. This endpoint retrieves a detailed history of all rewards that the member has previously redeemed. Using the provided member ID, it returns a list of rewards the member has utilized, including details such as reward names, redemption dates, usage status, and any associated metadata. This allows tracking of past reward usage and helps administrators monitor reward consumption over time. This endpoint supports various query parameters to refine the response and provide more precise data."}},"httpPath":"/users/{{member_id}}/rewards/history"},{"label":"Assign a reward to member","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/rewards-v2/postassignreward","routeSlug":"/loyalty/loyalty/rewards-v2/postassignreward","metadata":{"seo":{"title":"Assign a reward to member","description":"This endpoint is used to assign a reward to a specific member. It requires both the reward ID and member ID, along with details about the assignment, such as the source type. Successful assignments enable businesses to track which rewards have been issued and manage member benefits effectively."}},"httpPath":"/rewards/{{reward_id}}/users/{{member_id}}/assign"},{"label":"Update data against the reward awarded to member","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/rewards-v2/patchrewardsassign","routeSlug":"/loyalty/loyalty/rewards-v2/patchrewardsassign","metadata":{"seo":{"title":"Update data against the reward awarded to member","description":"This endpoint updates the details of a reward awarded to a specific member. It requires assign ID, reward ID and member ID, along with relevant assignment details such as the source type and collected data. This ensures businesses can track issued rewards and manage member benefits effectively."}},"httpPath":"/rewards/{{reward_id}}/users/{{member_id}}/assign"}]},{"type":"group","label":"Journeys","link":"/loyalty/loyalty/journeys","routeSlug":"/loyalty/loyalty/journeys","items":[{"label":"Get all user journeys","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/journeys/getjourneys","routeSlug":"/loyalty/loyalty/journeys/getjourneys","metadata":{"seo":{"title":"Get all user journeys","description":"This API retrieves a list of all member journeys available for a site. Each journey represents a sequence of steps or processes that a member can follow, such as opting into a program or completing a specific flow. The response provides details such as the journey's name, description, status, creation information, and relevant metadata."}},"httpPath":"/journeys"},{"label":"Get journey details by journey ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/journeys/getjourneysjourneyid","routeSlug":"/loyalty/loyalty/journeys/getjourneysjourneyid","metadata":{"seo":{"title":"Get journey details by journey ID","description":"The purpose of this endpoint is to provide detailed information about a specific journey within the system. Journeys are structured workflows or paths that define how members interact with the platform. Each journey is composed of various nodes (steps or actions) and their connections, representing the flow of member activities or system events. Note - If a member performs a blocking event during the hold period, the parameters hold_start_datetime and hold_end_datetime will not be displayed. Instead, blocked_by and blocked_at will be shown, and the reward status will be marked as blocked."}},"httpPath":"/journeys/{{journey_id}}"},{"label":"Get User Journey specific details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/journeys/getuserjourneysemailid","routeSlug":"/loyalty/loyalty/journeys/getuserjourneysemailid","metadata":{"seo":{"title":"Get User Journey specific details","description":"This endpoint retrieves a list of user journeys specifically associated with a member identified by their email address. A user journey represents a series of events, milestones, or actions that the member has completed within a system or platform—often tied to rewards, activities, or engagement workflows. This API enables businesses and developers to monitor user progress, assess engagement, and deliver personalized incentives based on the user's journey"}},"httpPath":"/user_journeys/{{email_id}}"},{"label":"Get member specific User Journey","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/journeys/getuseremailidjourneys","routeSlug":"/loyalty/loyalty/journeys/getuseremailidjourneys","metadata":{"seo":{"title":"Get member specific User Journey","description":"This endpoint retrieves a list of user journey specifically associated with a member identified by their email Id. A journey represents a series of events, milestones, or actions that a member has completed within a given system or platform, often tied to rewards, activities, or engagement processes. This API allows businesses and developers to track member progress, measure engagement, and offer personalized incentives based on the user's journey. Note - If a member performs a blocking event during the hold period, the parameters hold_start_datetime and hold_end_datetime will not be displayed. Instead, blocked_by and blocked_at will be shown, and the reward status will be marked as blocked."}},"httpPath":"/user/{{email_id}}/journeys"},{"label":"Retrieves the list of journeys associated with a specific badge.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/journeys/getbadgebadgeidjourneys","routeSlug":"/loyalty/loyalty/journeys/getbadgebadgeidjourneys","metadata":{"seo":{"title":"Retrieves the list of journeys associated with a specific badge.","description":"This method displays all journeys that are linked to the provided badge ID. It allows users to identify the journeys through which a badge can be earned, supporting better visualization and configuration of badge-related earning paths."}},"httpPath":"/badges{{badge_id}}journeys"},{"label":"Retrieves the list of journeys associated with a specific reward","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/journeys/getrewardsrewardidjourneys","routeSlug":"/loyalty/loyalty/journeys/getrewardsrewardidjourneys","metadata":{"seo":{"title":"Retrieves the list of journeys associated with a specific reward","description":"This method displays all user journeys that are linked to the provided reward ID. It helps users understand through which journeys a particular reward can be earned, making it easier to map reward eligibility and earning criteria in the system."}},"httpPath":"/rewards{{reward_id}}journeys"}]},{"type":"group","label":"Events","link":"/loyalty/loyalty/events","routeSlug":"/loyalty/loyalty/events","items":[{"label":"Captures a single event with associated user details, event attributes, and system metadata.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/events/postevents","routeSlug":"/loyalty/loyalty/events/postevents","metadata":{"seo":{"title":"Captures a single event with associated user details, event attributes, and system metadata.","description":"To record an event in the system, use the POST method in the Events API. The request must include the event type, user information (such as identifiers), event attributes, and metadata. All other additional fields in the request and response body are listed below."}},"httpPath":"/event"},{"label":"Creates a new event with a defined schema","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/events/paths/~1api~13.0~1journeys~1events/post","routeSlug":"/loyalty/loyalty/events/paths/~1api~13.0~1journeys~1events/post","metadata":{"seo":{"title":"Creates a new event with a defined schema","description":"Use this endpoint to create and configure a new event within the system. The request body must define the event's name, schema, and related configuration details. Once created, the event can be tracked, associated with users, and leveraged for reporting, segmentation, and journey workflows. Authentication and valid site details are required to access this resource."}},"httpPath":"/api/3.0/journeys/events"},{"label":"Retrieves the list of events configured in the system","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/events/getevents","routeSlug":"/loyalty/loyalty/events/getevents","metadata":{"seo":{"title":"Retrieves the list of events configured in the system","description":"Use this endpoint to fetch all events that are configured within the system. The response provides details of the available events and supports pagination to manage large result sets. Authentication and valid site details are required to access this resource."}},"httpPath":"/api/3.0/journeys/events"},{"label":"Deletes an event by its unique identifier","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/loyalty/loyalty/events/deleteevent","routeSlug":"/loyalty/loyalty/events/deleteevent","metadata":{"seo":{"title":"Deletes an event by its unique identifier","description":"Use this endpoint to permanently remove an event from the system by specifying its unique event ID in the request path. Once deleted, the event and its schema definition will no longer be available for tracking or reporting. Authentication and valid site details are required to perform this action."}},"httpPath":"/api/3.0/journeys/events/{event_id}"}]}]},{"type":"group","label":"Multi-Point Bucket","items":[{"type":"link","label":"Multi-Point Bucket V3 APIs","link":"/mpb/mpb","routeSlug":"/mpb/mpb"},{"type":"group","label":"Tiers","link":"/mpb/mpb/tiers","routeSlug":"/mpb/mpb/tiers","items":[{"label":"Get tier information for a loyalty member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/mpb/mpb/tiers/gettiersinfo","routeSlug":"/mpb/mpb/tiers/gettiersinfo","metadata":{"seo":{"title":"Get tier information for a loyalty member","description":"This method retrieves tier details for a specific member using their member ID."}},"httpPath":"/users/{{memberId}}/tiers"}]},{"type":"group","label":"Orders","link":"/mpb/mpb/orders","routeSlug":"/mpb/mpb/orders","items":[{"label":"Create new order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/mpb/mpb/orders/createorder","routeSlug":"/mpb/mpb/orders/createorder","metadata":{"seo":{"title":"Create new order","description":"Use the POST method in the Orders API to create a new order placed by a member of the loyalty program. Include fields such as email, first name, last name, order total, coupon code, reward, and any additional fields as needed."}},"httpPath":"/orders"},{"label":"Update the order","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/mpb/mpb/orders/updateorder","routeSlug":"/mpb/mpb/orders/updateorder","metadata":{"seo":{"title":"Update the order","description":"Use the PATCH method in the Orders API to update the order status of a shipment to ship, return, or cancel status in the input parameter. Orders can be updated based on their status, including partial or full shipment of the order, partial or full return of the product, and partial or full cancellation of the order."}},"httpPath":"/orders/{{orderId}}"}]},{"type":"group","label":"Rewards","link":"/mpb/mpb/rewards","routeSlug":"/mpb/mpb/rewards","items":[{"label":"Fetch the list of all rewards for a member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/mpb/mpb/rewards/getrewardsbyuser","routeSlug":"/mpb/mpb/rewards/getrewardsbyuser","metadata":{"seo":{"title":"Fetch the list of all rewards for a member","description":"This method can be used to retrieve a list of all available rewards against a member ID. The administrator needs to pass a unique member ID as the key to fetch the details."}},"httpPath":"/users/{{memberId}}/reward"}]},{"type":"group","label":"Points","link":"/mpb/mpb/points","routeSlug":"/mpb/mpb/points","items":[{"label":"Redeem, and award loyalty points to the member","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/mpb/mpb/points/addorredeempoints","routeSlug":"/mpb/mpb/points/addorredeempoints","metadata":{"seo":{"title":"Redeem, and award loyalty points to the member","description":"Use the POST method in the Points API to give, redeem and award points to members of the loyalty program. All other fields in the request body are listed below."}},"httpPath":"/points"},{"label":"To retrieve point details for a member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/mpb/mpb/points/add/removepoints","routeSlug":"/mpb/mpb/points/add/removepoints","metadata":{"seo":{"title":"To retrieve point details for a member","description":"This method retrieves point details associated with a member’s ID. The user needs to use the member’s user ID as a key to fetch all the points details."}},"httpPath":"/points/{{memberId}}"}]},{"type":"group","label":"Product","link":"/mpb/mpb/product","routeSlug":"/mpb/mpb/product","items":[{"label":"Enter the product information to calculate how many points the member will earn for their purchase","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/mpb/mpb/product/productpoints","routeSlug":"/mpb/mpb/product/productpoints","metadata":{"seo":{"title":"Enter the product information to calculate how many points the member will earn for their purchase","description":"This API is used to display the points that a member will earn for purchasing a product."}},"httpPath":"/products"}]},{"type":"group","label":"Cart","link":"/mpb/mpb/cart","routeSlug":"/mpb/mpb/cart","items":[{"label":"Points earned for the product(s) in cart","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/mpb/mpb/cart/productpointscart","routeSlug":"/mpb/mpb/cart/productpointscart","metadata":{"seo":{"title":"Points earned for the product(s) in cart","description":"This method is used to display the number of points members will earn upon purchasing the products in their cart. This method accounts for any points the member is applying to the order in their cart for redemption."}},"httpPath":"/cart"}]}]},{"type":"group","label":"Incentive Engine Management","items":[{"type":"link","label":"Incentive Engine V3 APIs","link":"/iem/iem","routeSlug":"/iem/iem"},{"type":"group","label":"Incentive Codes","link":"/iem/iem/incentive-codes","routeSlug":"/iem/iem/incentive-codes","items":[{"label":"This API facilitates the generation of both full and partial","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iem/iem/incentive-codes/incentivecodes","routeSlug":"/iem/iem/incentive-codes/incentivecodes","metadata":{"seo":{"title":"This API facilitates the generation of both full and partial","description":"This API facilitates the generation of both full and partial"}},"httpPath":"/incentive/codes"}]},{"type":"group","label":"Code Assign","link":"/iem/iem/code-assign","routeSlug":"/iem/iem/code-assign","items":[{"label":"This API facilitates the assignment and reassignment of codes, sourced from Fixed or Dynamic groups to members","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iem/iem/code-assign/assigncodes","routeSlug":"/iem/iem/code-assign/assigncodes","metadata":{"seo":{"title":"This API facilitates the assignment and reassignment of codes, sourced from Fixed or Dynamic groups to members","description":"This API facilitates the assignment and reassignment of codes, sourced from Fixed or Dynamic groups to members"}},"httpPath":"/incentive/assigncode"}]},{"type":"group","label":"Code Validity","link":"/iem/iem/code-validity","routeSlug":"/iem/iem/code-validity","items":[{"label":"Validate incentive code","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iem/iem/code-validity/getcodevaliditydetails","routeSlug":"/iem/iem/code-validity/getcodevaliditydetails","metadata":{"seo":{"title":"Validate incentive code","description":"This API method is used to check the validity of the incentive code assigned to the member."}},"httpPath":"/incentive/validatecode/{{incentiveCode}}"}]},{"type":"group","label":"Code Update","link":"/iem/iem/code-update","routeSlug":"/iem/iem/code-update","items":[{"label":"Update code details","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iem/iem/code-update/updatecodedetails","routeSlug":"/iem/iem/code-update/updatecodedetails","metadata":{"seo":{"title":"Update code details","description":"This API method facilitates both redemption and undo-redemption operations for incentive codes."}},"httpPath":"/incentive/updatecodedetails/{{memberId}}"},{"label":"Update code configurations","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iem/iem/code-update/updatecodeconfig","routeSlug":"/iem/iem/code-update/updatecodeconfig","metadata":{"seo":{"title":"Update code configurations","description":"The API method is designed for updating incentive code details, including status and value. Note that the \"value\" parameter is relevant only for partial redemption types."}},"httpPath":"/incentive/updatecodeconfig/{memberId}}"},{"label":"Update batch code details","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iem/iem/code-update/updatebatchcode","routeSlug":"/iem/iem/code-update/updatebatchcode","metadata":{"seo":{"title":"Update batch code details","description":"This API method facilitates the deduction of an amount from multiple gift cards or store credits. (It is designed to handle multiple redemption and undo redemption operations.)"}},"httpPath":"/incentive/updatebatchcodedetails/{{siteId}}"}]},{"type":"group","label":"User Code Details","link":"/iem/iem/user-code-details","routeSlug":"/iem/iem/user-code-details","items":[{"label":"Fetch Details of Codes","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iem/iem/user-code-details/postusercodedetails","routeSlug":"/iem/iem/user-code-details/postusercodedetails","metadata":{"seo":{"title":"Fetch Details of Codes","description":"This API method is used to fetch the details for the incentive codes that have been assigned to a member by passing the member’s user ID."}},"httpPath":"/incentive/usercodedetails"},{"label":"Fetch Details of Code","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iem/iem/user-code-details/usercodedetailsuserid","routeSlug":"/iem/iem/user-code-details/usercodedetailsuserid","metadata":{"seo":{"title":"Fetch Details of Code","description":"This API method retrieves the details for incentive codes, including the associated code groups for the incentive codes assigned to a member by passing their User ID."}},"httpPath":"/incentive/usercodedetails/{{memberId}}"}]},{"type":"group","label":"Bulk Assignment","link":"/iem/iem/bulk-assignment","routeSlug":"/iem/iem/bulk-assignment","items":[{"label":"Bulk assignment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iem/iem/bulk-assignment/postbulkassignment","routeSlug":"/iem/iem/bulk-assignment/postbulkassignment","metadata":{"seo":{"title":"Bulk assignment","description":"This API facilitates the assignment of generated codes to multiple members within the system. It streamlines the process of distributing codes, ensuring efficient allocation to the intended recipients."}},"httpPath":"/incentive/bulkassignment"}]},{"type":"group","label":"Redemption Log","link":"/iem/iem/redemption-log","routeSlug":"/iem/iem/redemption-log","items":[{"label":"Get count of Redemptions API","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iem/iem/redemption-log/postredemptionlog","routeSlug":"/iem/iem/redemption-log/postredemptionlog","metadata":{"seo":{"title":"Get count of Redemptions API","description":"This API retrieves details regarding redemptions and undo-redemptions carried out within the system."}},"httpPath":"/incentive/getredemptionlog"}]},{"type":"group","label":"Get All Incentive Groups","link":"/iem/iem/get-all-incentive-groups","routeSlug":"/iem/iem/get-all-incentive-groups","items":[{"label":"Group Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iem/iem/get-all-incentive-groups/getallincentivegroups","routeSlug":"/iem/iem/get-all-incentive-groups/getallincentivegroups","metadata":{"seo":{"title":"Group Details","description":"This API is used to get details for a specific incentive code group by passing the Group ID."}},"httpPath":"/incentive/getincentivegroup/{{groupId}}"},{"label":"All Group Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iem/iem/get-all-incentive-groups/getallincentivegroupdetails","routeSlug":"/iem/iem/get-all-incentive-groups/getallincentivegroupdetails","metadata":{"seo":{"title":"All Group Details","description":"This API method is used to get details for all the incentive code groups by passing “all” as the path parameter."}},"httpPath":"/incentive/getallincentivegroups/{{all}}"}]}]},{"type":"group","label":"Tenant","items":[{"type":"link","label":"Tenant V3 APIs","link":"/tenant/tenant","routeSlug":"/tenant/tenant"},{"type":"group","label":"Tenant","link":"/tenant/tenant/tenant","routeSlug":"/tenant/tenant/tenant","items":[{"label":"Fetch the Site Information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tenant/tenant/tenant/getsitedetailstenant","routeSlug":"/tenant/tenant/tenant/getsitedetailstenant","metadata":{"seo":{"title":"Fetch the Site Information","description":"This API is used to fetch the site Information."}},"httpPath":"/getsiteid"},{"label":"Fetch the profile information of the users of a particular site","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tenant/tenant/tenant/getinformationtenant","routeSlug":"/tenant/tenant/tenant/getinformationtenant","metadata":{"seo":{"title":"Fetch the profile information of the users of a particular site","description":"This API is used to fetch the profile information of the users against the site ID."}},"httpPath":"/getinfo"},{"label":"Fetch the user's profile information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tenant/tenant/tenant/getprofiletenant","routeSlug":"/tenant/tenant/tenant/getprofiletenant","metadata":{"seo":{"title":"Fetch the user's profile information","description":"This API is used to fetch a user's profile information."}},"httpPath":"/getprofile"},{"label":"Fetch the user's profile information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tenant/tenant/tenant/getroledetailtenant","routeSlug":"/tenant/tenant/tenant/getroledetailtenant","metadata":{"seo":{"title":"Fetch the user's profile information","description":"This API is used to fetch a user's profile information."}},"httpPath":"/getroledetail"},{"label":"Create the user","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tenant/tenant/tenant/putcreatetenant","routeSlug":"/tenant/tenant/tenant/putcreatetenant","metadata":{"seo":{"title":"Create the user","description":"This API is used to create the user. The users created by this API are shown in the users list in the Users tab in the Annex Cloud ADR."}},"httpPath":"/create"},{"label":"Update the user's information","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tenant/tenant/tenant/putupdatetenant","routeSlug":"/tenant/tenant/tenant/putupdatetenant","metadata":{"seo":{"title":"Update the user's information","description":"This API is used to update the information of the user."}},"httpPath":"/update"},{"label":"Generate the JWT token","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tenant/tenant/tenant/gettokentenant","routeSlug":"/tenant/tenant/tenant/gettokentenant","metadata":{"seo":{"title":"Generate the JWT token","description":"This API is used to generate the JWT token against the payload. The payloads are different for each method. For each method, a token has to be generated whenever you call the API in a two-step method."}},"httpPath":"/gettoken"}]}]},{"type":"group","label":"Privacy Policy Management","items":[{"type":"link","label":"Privacy Policy Management V3 APIs","link":"/ppm/ppm","routeSlug":"/ppm/ppm"},{"type":"group","label":"User Delete","link":"/ppm/ppm/user-delete","routeSlug":"/ppm/ppm/user-delete","items":[{"label":"Generate an authorization token","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ppm/ppm/user-delete/tenantprivacygettoken","routeSlug":"/ppm/ppm/user-delete/tenantprivacygettoken","metadata":{"seo":{"title":"Generate an authorization token","description":"In order to make a successful delete request using the privacy api, you must start by generating an authorization token that you will use to make the request."}},"httpPath":"/tenant/privacy/gettoken"},{"label":"Delete member from one or multiple sites","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ppm/ppm/user-delete/deleteuser","routeSlug":"/ppm/ppm/user-delete/deleteuser","metadata":{"seo":{"title":"Delete member from one or multiple sites","description":"This method is used to request the deletion of members. When a user submits a member deletion request, the API endpoint designated for handling such requests uses the DELETE method to remove the member from the system. This ensures that the members are permanently deleted from the database. This API will receive and store the requests in the queue periodically. The delete request runs every 12 hours at 05:30 AM UTC and 05:30 PM UTC. Member by member in the queue will be picked and deleted from every table in the database."}},"httpPath":"/deleteuser"},{"label":"Revoke Delete Request","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ppm/ppm/user-delete/revokeuser","routeSlug":"/ppm/ppm/user-delete/revokeuser","metadata":{"seo":{"title":"Revoke Delete Request","description":"When a user requests to delete a member, the request will be in a queue, and within 12 hours the request will be deleted his personal information. If the user wants to revoke his request within 12 hours then it can be cancelled. But beyond 12 hours if the user wants to revoke his requisition, then the request cannot be cancelled. In this API if the user makes the revoke request before getting deleted, then his request to delete the member is removed from the queue."}},"httpPath":"/revokeuser"}]},{"type":"group","label":"User Group Details","link":"/ppm/ppm/user-group-details","routeSlug":"/ppm/ppm/user-group-details","items":[{"label":"User Group Details","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ppm/ppm/user-group-details/usergroupdetails","routeSlug":"/ppm/ppm/user-group-details/usergroupdetails","metadata":{"seo":{"title":"User Group Details","description":"The Get Token process is a critical first step for initiating privacy-related requests, such as delete operations, within the Privacy API. This endpoint generates an authorization token to ensure secure and authorized access, which must be included in all subsequent API requests. User group details are validated twice daily—at 12:00 AM and 12:00 PM UTC. The data is processed group by group, and group details from either a single site or multiple sites are delivered via email in a JSON response format."}},"httpPath":"/getuserdetails"}]}]},{"type":"group","label":"Refer A Friend","items":[{"type":"link","label":"Refer a Friend V3 APIs","link":"/raf/raf","routeSlug":"/raf/raf"},{"type":"group","label":"User","link":"/raf/raf/user","routeSlug":"/raf/raf/user","items":[{"label":"Create a new user account under a specific site","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/raf/raf/user/invitecodecoupon","routeSlug":"/raf/raf/user/invitecodecoupon","metadata":{"seo":{"title":"Create a new user account under a specific site","description":"This POST endpoint allows you to create a new user account under a specific site."}},"httpPath":"/createuser/{{siteId}}?access_token={{access_token}}"},{"label":"Get referral status","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/raf/raf/user/invitecode","routeSlug":"/raf/raf/user/invitecode","metadata":{"seo":{"title":"Get referral status","description":"This API is used to get the referral status of the referee (the friend who was referred by a member)."}},"httpPath":"/Referralstatus/{{siteId}}?access_token={{access_token}}"},{"label":"Create or Assign a new invite code coupon for a specific site","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/raf/raf/user/invitecodecoupon","routeSlug":"/raf/raf/user/invitecodecoupon","metadata":{"seo":{"title":"Create or Assign a new invite code coupon for a specific site","description":"This API is used to unlock the coupon code for the referee/friend."}},"httpPath":"/Invitecodecoupon/{{siteId}}?access_token={{access_token}}"},{"label":"Retrive the sharer email address","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/raf/raf/user/getshareremail","routeSlug":"/raf/raf/user/getshareremail","metadata":{"seo":{"title":"Retrive the sharer email address","description":"This API is used to get member information registered in the RAF module by providing an email address and incentive ID."}},"httpPath":"/userinformation/{{siteId}}?access_token={{access_token}}"},{"label":"Get referrer's details","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/raf/raf/user/invitecodedetail","routeSlug":"/raf/raf/user/invitecodedetail","metadata":{"seo":{"title":"Get referrer's details","description":"This API is used to get the referrer’s details through the stat ID and invite code."}},"httpPath":"/userinvitecodedetail/{{siteId}}?access_token={{access_token}}"}]},{"type":"group","label":"Refer","link":"/raf/raf/refer","routeSlug":"/raf/raf/refer","items":[{"label":"Create bitly links","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/raf/raf/refer/createbitly","routeSlug":"/raf/raf/refer/createbitly","metadata":{"seo":{"title":"Create bitly links","description":"This API is used to create bitly links for specific member’s Facebook, Twitter, and Email Sharing."}},"httpPath":"/Createbitly/{{siteId}}?access_token={{access_token}}"},{"label":"Send e-mail to friends","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/raf/raf/refer/referralstatus","routeSlug":"/raf/raf/refer/referralstatus","metadata":{"seo":{"title":"Send e-mail to friends","description":"This API is used to trigger invitation emails to friends."}},"httpPath":"/Sendemail/{{siteId}}?access_token={{access_token}}"}]},{"type":"group","label":"Reward","link":"/raf/raf/reward","routeSlug":"/raf/raf/reward","items":[{"label":"Generate a coupon code for an invitee using a referral invite code","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/raf/raf/reward/invitecouponsiteidaccesstoken","routeSlug":"/raf/raf/reward/invitecouponsiteidaccesstoken","metadata":{"seo":{"title":"Generate a coupon code for an invitee using a referral invite code","description":"This endpoint is used to generate and assign a coupon code to a referred user (invitee) based on a valid referral invite code."}},"httpPath":"/Invitecodecoupon/{{site_id}}?access_token={{access_token}}"}]}]},{"type":"group","label":"Registration as a Service","items":[{"type":"link","label":"Registration as a Service V3 APIs","link":"/raas/raas","routeSlug":"/raas/raas"},{"type":"group","label":"Users","link":"/raas/raas/users","routeSlug":"/raas/raas/users","items":[{"label":"Reset the password for a member","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/raas/raas/users/forgotpassword","routeSlug":"/raas/raas/users/forgotpassword","metadata":{"seo":{"title":"Reset the password for a member","description":"This API is used to reset the password for a member if the member forgets their password. A reset password link will be sent to the email address that was provided to Annex Cloud upon their registration."}},"httpPath":"/forgotPassword"},{"label":"Register a member in the RaaS module","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/raas/raas/users/register","routeSlug":"/raas/raas/users/register","metadata":{"seo":{"title":"Register a member in the RaaS module","description":"This API is used for members to become registered in the RaaS module."}},"httpPath":"/register"},{"label":"Edit the member's information in the RaaS module","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/raas/raas/users/edituser","routeSlug":"/raas/raas/users/edituser","metadata":{"seo":{"title":"Edit the member's information in the RaaS module","description":"This API is used to edit the member's information that already exists in the RaaS database and to add new information that was not provided when the member was registered into the RaaS module."}},"httpPath":"/editUser"},{"label":"Log in as a member in the RaaS module","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/raas/raas/users/login","routeSlug":"/raas/raas/users/login","metadata":{"seo":{"title":"Log in as a member in the RaaS module","description":"This API is used to login into the RaaS module for members by using their login credentials."}},"httpPath":"/login"}]}]},{"type":"group","label":"Webhooks","items":[{"type":"link","label":"Webhooks APIs","link":"/webhooks/webhooks","routeSlug":"/webhooks/webhooks"},{"type":"group","label":"Webhooks","link":"/webhooks/webhooks/webhooks","routeSlug":"/webhooks/webhooks/webhooks","items":[{"label":"Retrieves a paginated list of all webhook configurations.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/webhooks/webhooks/webhooks/getwebhooks","routeSlug":"/webhooks/webhooks/webhooks/getwebhooks","metadata":{"seo":{"title":"Retrieves a paginated list of all webhook configurations.","description":"Retrieves a paginated list of all webhook configurations."}},"httpPath":"/api/v1/webhooks"},{"label":"Creates a webhook configuration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/webhooks/webhooks/webhooks/postwebhooks","routeSlug":"/webhooks/webhooks/webhooks/postwebhooks","metadata":{"seo":{"title":"Creates a webhook configuration","description":"This API creates a new webhook configuration based on the specified details such as feed type,target URL, HTTP method, and event types. The request allows configuration of retry behavior,timeout settings, and webhook enablement. The response returns the created webhook details along with execution status information."}},"httpPath":"/api/v1/webhooks"},{"label":"Retrieves detailed information for a specific webhook.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/webhooks/webhooks/webhooks/getwebhookid","routeSlug":"/webhooks/webhooks/webhooks/getwebhookid","metadata":{"seo":{"title":"Retrieves detailed information for a specific webhook.","description":"Retrieves a list of webhook configurations with pagination support."}},"httpPath":"/api/v1/webhooks/{{id}}"},{"label":"Toggles the enabled state of a webhook.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/webhooks/webhooks/webhooks/patchwebhook","routeSlug":"/webhooks/webhooks/webhooks/patchwebhook","metadata":{"seo":{"title":"Toggles the enabled state of a webhook.","description":"This API toggles the enabled state of an existing webhook configuration.The webhook to be updated is identified using the webhook ID passed as a path parameter."}},"httpPath":"/api/v1/webhooks/{{id}}"},{"label":"Permanently deletes a webhook configuration.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/webhooks/webhooks/webhooks/deletewebhooks","routeSlug":"/webhooks/webhooks/webhooks/deletewebhooks","metadata":{"seo":{"title":"Permanently deletes a webhook configuration.","description":"This API permanently deletes an existing webhook configuration.The webhook to be deleted is identified using the webhook ID passed as a path parameter. This API does not require a request body."}},"httpPath":"/api/v1/webhooks/{{id}}"},{"label":"Validates webhook configuration without creating it.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/webhooks/webhooks/webhooks/postvalidatewebhook","routeSlug":"/webhooks/webhooks/webhooks/postvalidatewebhook","metadata":{"seo":{"title":"Validates webhook configuration without creating it.","description":"This API validates a webhook configuration without creating it. The request body follows the same structure as the Create Webhook API and checks whether the provided webhook configuration is valid."}},"httpPath":"/api/v1/webhooks/validate"}]}]},{"type":"group","label":"Webhooks Events","items":[{"type":"link","label":"Webhook Events API","link":"/web/web","routeSlug":"/web/web"},{"type":"group","label":"User Events","link":"/web/web/user-events","routeSlug":"/web/web/user-events","items":[{"label":"User Create Event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/web/web/user-events/paths/usercreate/post","routeSlug":"/web/web/user-events/paths/usercreate/post","metadata":{"seo":{"title":"User Create Event","description":"Displays user lifecycle events such as member creation and profile updates."}},"httpPath":"UserCreate"},{"label":"User Update Event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/web/web/user-events/paths/userupdate/post","routeSlug":"/web/web/user-events/paths/userupdate/post","metadata":{"seo":{"title":"User Update Event","description":"Displays user lifecycle events such as member creation and profile updates."}},"httpPath":"UserUpdate"}]},{"type":"group","label":"Badge Events","link":"/web/web/badge-events","routeSlug":"/web/web/badge-events","items":[{"label":"Badge Awarded Event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/web/web/badge-events/paths/badgeawarded/post","routeSlug":"/web/web/badge-events/paths/badgeawarded/post","metadata":{"seo":{"title":"Badge Awarded Event","description":"Displays events when a badge is awarded to a member."}},"httpPath":"BadgeAwarded"}]},{"type":"group","label":"Reward Events","link":"/web/web/reward-events","routeSlug":"/web/web/reward-events","items":[{"label":"Displays reward lifecycle events.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/web/web/reward-events/paths/rewardused/post","routeSlug":"/web/web/reward-events/paths/rewardused/post","metadata":{"seo":{"title":"Displays reward lifecycle events.","description":"Triggered when a reward is used."}},"httpPath":"RewardUsed"},{"label":"Displays reward lifecycle events.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/web/web/reward-events/paths/rewardexpiring/post","routeSlug":"/web/web/reward-events/paths/rewardexpiring/post","metadata":{"seo":{"title":"Displays reward lifecycle events.","description":"Triggered when a reward is nearing expiration."}},"httpPath":"RewardExpiring"},{"label":"Reward Awarded Event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/web/web/reward-events/paths/rewardawarded/post","routeSlug":"/web/web/reward-events/paths/rewardawarded/post","metadata":{"seo":{"title":"Reward Awarded Event","description":"Displays reward lifecycle events including awarding, expiry, and alerts."}},"httpPath":"RewardAwarded"},{"label":"Reward Expired Event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/web/web/reward-events/paths/rewardexpired/post","routeSlug":"/web/web/reward-events/paths/rewardexpired/post","metadata":{"seo":{"title":"Reward Expired Event","description":"Displays reward lifecycle events including awarding, expiry, and alerts."}},"httpPath":"RewardExpired"},{"label":"Reward Low Coupon Alert Event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/web/web/reward-events/paths/rewardlowcouponalert/post","routeSlug":"/web/web/reward-events/paths/rewardlowcouponalert/post","metadata":{"seo":{"title":"Reward Low Coupon Alert Event","description":"Displays reward lifecycle events including awarding, expiry, and alerts."}},"httpPath":"RewardLowCouponAlert"}]},{"type":"group","label":"Journey Events","link":"/web/web/journey-events","routeSlug":"/web/web/journey-events","items":[{"label":"Journey In Progress Event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/web/web/journey-events/paths/journeyinprogress/post","routeSlug":"/web/web/journey-events/paths/journeyinprogress/post","metadata":{"seo":{"title":"Journey In Progress Event","description":"Displays member journey progress including in-progress, completed, and abandoned states."}},"httpPath":"JourneyInProgress"},{"label":"Journey Completed Event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/web/web/journey-events/paths/journeycompleted/post","routeSlug":"/web/web/journey-events/paths/journeycompleted/post","metadata":{"seo":{"title":"Journey Completed Event","description":"Displays member journey progress including in-progress, completed, and abandoned states."}},"httpPath":"JourneyCompleted"},{"label":"Journey Abandoned Event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/web/web/journey-events/paths/journeyabandoned/post","routeSlug":"/web/web/journey-events/paths/journeyabandoned/post","metadata":{"seo":{"title":"Journey Abandoned Event","description":"Displays member journey progress including in-progress, completed, and abandoned states."}},"httpPath":"JourneyAbandoned"}]},{"type":"group","label":"Point Events","link":"/web/web/point-events","routeSlug":"/web/web/point-events","items":[{"label":"Point Balance User Event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/web/web/point-events/paths/pointbalanceuser/post","routeSlug":"/web/web/point-events/paths/pointbalanceuser/post","metadata":{"seo":{"title":"Point Balance User Event","description":"Displays updates to points balance for members and groups."}},"httpPath":"PointBalanceUser"},{"label":"Point Balance Group Event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/web/web/point-events/onpointbalancegroup","routeSlug":"/web/web/point-events/onpointbalancegroup","metadata":{"seo":{"title":"Point Balance Group Event","description":"Displays updates to points balance for members and groups."}},"httpPath":"PointBalanceGroup"}]},{"type":"group","label":"Tier Events","link":"/web/web/tier-events","routeSlug":"/web/web/tier-events","items":[{"label":"Get member tier change details","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/web/web/tier-events/paths/tierchange/post","routeSlug":"/web/web/tier-events/paths/tierchange/post","metadata":{"seo":{"title":"Get member tier change details","description":"Provides a structured view of a user’s tier transition, enabling systems to process updates, trigger benefits, and maintain accurate user status."}},"httpPath":"TierChange"}]},{"type":"group","label":"Transaction Events","link":"/web/web/transaction-events","routeSlug":"/web/web/transaction-events","items":[{"label":"Displays user transaction lifecycle events.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/web/web/transaction-events/paths/transaction user event/post","routeSlug":"/web/web/transaction-events/paths/transaction user event/post","metadata":{"seo":{"title":"Displays user transaction lifecycle events.","description":"Triggered when a transaction is created or updated for a user."}},"httpPath":"Transaction User Event"},{"label":"Displays group transaction lifecycle events.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/web/web/transaction-events/paths/transaction group event/post","routeSlug":"/web/web/transaction-events/paths/transaction group event/post","metadata":{"seo":{"title":"Displays group transaction lifecycle events.","description":"Triggered when a transaction is created or updated for a group."}},"httpPath":"Transaction Group Event"}]},{"type":"group","label":"Fraud Detection Events","link":"/web/web/fraud-detection-events","routeSlug":"/web/web/fraud-detection-events","items":[{"label":"Displays fraud detection lifecycle events.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/web/web/fraud-detection-events/paths/fraud detection alert event/post","routeSlug":"/web/web/fraud-detection-events/paths/fraud detection alert event/post","metadata":{"seo":{"title":"Displays fraud detection lifecycle events.","description":"Displays the details about fraud detection events."}},"httpPath":"Fraud Detection Alert Event"}]},{"type":"group","label":"Group Events","link":"/web/web/group-events","routeSlug":"/web/web/group-events","items":[{"label":"Displays group lifecycle events such as group creation.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/web/web/group-events/paths/groupcreate/post","routeSlug":"/web/web/group-events/paths/groupcreate/post","metadata":{"seo":{"title":"Displays group lifecycle events such as group creation.","description":"This event is triggered when a new group is created in the system."}},"httpPath":"GroupCreate"},{"label":"Displays group lifecycle events such as group updates.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/web/web/group-events/paths/groupupdate/patch","routeSlug":"/web/web/group-events/paths/groupupdate/patch","metadata":{"seo":{"title":"Displays group lifecycle events such as group updates.","description":"This event is triggered when an existing group is updated in the system."}},"httpPath":"GroupUpdate"},{"label":"Displays group lifecycle events such as group deletion.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/web/web/group-events/paths/groupdelete/delete","routeSlug":"/web/web/group-events/paths/groupdelete/delete","metadata":{"seo":{"title":"Displays group lifecycle events such as group deletion.","description":"This event is triggered when an existing group is deleted from the system."}},"httpPath":"GroupDelete"},{"label":"Displays group invitation lifecycle events such as sending invitations to members.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/web/web/group-events/paths/groupinvitesent/post","routeSlug":"/web/web/group-events/paths/groupinvitesent/post","metadata":{"seo":{"title":"Displays group invitation lifecycle events such as sending invitations to members.","description":"This event is triggered when one or more invitations are sent to users to join a group."}},"httpPath":"GroupInviteSent"},{"label":"Displays group invitation lifecycle events such as invitation acceptance.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/web/web/group-events/paths/groupinviteaccepteevent/patch","routeSlug":"/web/web/group-events/paths/groupinviteaccepteevent/patch","metadata":{"seo":{"title":"Displays group invitation lifecycle events such as invitation acceptance.","description":"This event is triggered when a user accepts an invitation and successfully joins a group."}},"httpPath":"GroupInviteAccepteEvent"},{"label":"Displays group invitation lifecycle events such as invitation rejection.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/web/web/group-events/paths/groupinviterejectedevent/patch","routeSlug":"/web/web/group-events/paths/groupinviterejectedevent/patch","metadata":{"seo":{"title":"Displays group invitation lifecycle events such as invitation rejection.","description":"This event is triggered when one or more users reject an invitation to join a group."}},"httpPath":"GroupInviteRejectedEvent"},{"label":"Displays group membership lifecycle events such as adding a new member to a group.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/web/web/group-events/paths/groupmemberaddedevent/post","routeSlug":"/web/web/group-events/paths/groupmemberaddedevent/post","metadata":{"seo":{"title":"Displays group membership lifecycle events such as adding a new member to a group.","description":"This event is triggered when a user successfully joins a group, either through an invitation or another supported membership process."}},"httpPath":"GroupMemberAddedEvent"},{"label":"Displays group membership lifecycle events such as removing a member from a group.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/web/web/group-events/paths/groupmemberremovedevent/put","routeSlug":"/web/web/group-events/paths/groupmemberremovedevent/put","metadata":{"seo":{"title":"Displays group membership lifecycle events such as removing a member from a group.","description":"This event is triggered when a member is removed from a group by an authorized user or through a group management process."}},"httpPath":"GroupMemberRemovedEvent"},{"label":"Displays group membership lifecycle events such as a member leaving a group.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/web/web/group-events/paths/groupmemberleaveevent/patch","routeSlug":"/web/web/group-events/paths/groupmemberleaveevent/patch","metadata":{"seo":{"title":"Displays group membership lifecycle events such as a member leaving a group.","description":"This event is triggered when a member voluntarily leaves a group."}},"httpPath":"GroupMemberLeaveEvent"}]}]}]}]}