JUMP TOGetting startedOverviewAPI reference indexAuthenticationOAuthBasic authenticationAuth for consumer or end-customer appsAuthorisationRate limitsAPI status codesTimezone managementMake your first API requestPluginsShopify pluginMagento pluginExtensionsIntroductionAPI ExtensionGetting StartedCreating and Managing APIsExamples of API creation and customisationTroubleshootingFAQsUsage document for Mongo blocksNeo DAO FunctionsUsage document for Redis blocksUI ExtensionGetting StartedApplication Development ProcessAPI Management on VulcanExamplesCreating a Microsite Using VulcanCustomizing the Member Care UIFAQsReporting on Extension Datamobile SDKsAndroid SDKOverviewConfigure firebaseSet up source accountConfigure gatewayInstall SDKInitialise SDKSet up events trackingPush notificationsIn-app messagingNotification centerXiaomi push notificationiOS SDKOverviewSet up source accountConfigure gatewayInstall SDKInitialise SDKSet up events trackingPush notificationsIn-app messagingNotification centerSetting up React native project for Hydra SDKIntegrate Push Notifications into your React Native projectIntegrate In-App messaging into your React Native projectIntegrate Notification center into your React Native projectv3Milestone & Streaks APIsCreate target groupspostUpdate target groupputGet target groups based on IDgetGet associated target groups of a usergetGet target periodsgetGet targets detailsgetGet target communication templategetUpsert target communicationpostGet target channelsgetDelete target groupdeleteCreate target periodpostUpdate target periodputCreate targets (milestone)postModify targetsputDeactivate targetdeleteCreate unified target grouppostUpdate unified targetputCreate streakspostEdit streakputCreate target based on Behavioural eventpostCreate target based on EMF eventpostGet all milestones (target)getEnrol/Re-enrol a customer to a milestone/streakpostUnenrol users from a milestone and streakpostEvent notification logsGet Event Log (by Request ID)getGet Event Log (by Reference ID)getGet Event Log (by Event ID)getResponse codev2 API ReferenceCustomerAdd CustomerpostGet Customer IDgetUpdate Identifier/Issue CardpostUpsert customerpostAssociate CustomerpostGet Customer DetailsgetGet customer hierarchy in a user groupgetUpdate Customer DetailsputUpdate association detailsputSearch CustomersgetUpdate Subscription DetailspostGet Subscription DetailsgetGet Points Expiry SchedulegetGet Points Expiry Schedule (Light API)getGet Loyalty EventsgetGet Loyalty DetailsgetGet Points Transfer SummarygetGet Points BalancegetGet Customer TiergetGet Points Conversion SchedulegetGet Customer Coupons (Detailed)getGet Retro RequestsgetGet Identifier Change RequestsgetGet Goodwill RequestsgetRequest Goodwill points (Group)postAdd Customer ImagepostDelete Customer ImagedeleteGet Customer Coupons (Basic)getLink/Delink CardpostAdd ReferralsgetGet ReferralsgetGet Customer Status LoggetGet Customer Subscription LoggetGet Customer ImagegetGet user group customer tracker detailsgetGet customer transactionsgetGet Customer InteractionsgetStatus codesCustomer (Lookup)Update Customer DetailsputGet Customer DetailsgetUpdate Customer StatusputGet Subscription DetailsgetGet Customer Loyalty DetailsgetGet Retro RequestsgetAdd Customer ImagepostGet Referrals (Lookup)getGet Customer RecommendationsgetGet Points BalancegetGet Customer TiergetGet Points Conversion SchedulegetDeduct points from userpostTransactionAdd/Return Transaction(bulk)postUpdate TransactionputAdd/Return transaction (single)postUpdate Transactions in BulkputGet Transaction DetailsgetGet transaction details using bill numbergetSimulation transaction addpostExpose Evaluation log for an eventpostStatus codesOTPGenerate OTPpostOTP template guidelinesValidate OTPpostGet OTPgetSuccess and error codesPointsCustomer Points TransferrablepostTransfer Customer PointspostGet Points Transfer DetailsgetReverse Redeemed PointspostGroup Points TransferrablepostTransfer Group PointspostPoints Unlock APIpostUpdate redeem pointsputPoints LedgerGet Customer Ledger BalancegetGet Points Ledger InformationgetGet Points Ledger Explode infogetCouponCreate coupon seriespostUpdate coupon seriesputGet coupon series detailsgetIssue single couponpostIssue bulk couponspostIssue multiple coupons to a customer from a seriespostRedeem single couponpostRedeem bulk couponspostCheck if coupon is RedeemablegetReactivate redeemed couponpostGet coupon detailsgetUpdate coupon redeem fieldputUpdate coupon code expiry dateputRevoke couponpostCustomer LabelsAdd LabelspostGet Org LabelsgetTag Customers (to Labels)postGet Customer LabelsgetSearch Customers by LabelgetUser AuthenticationRegister UserpostAuthorize UserpostUpdate PasswordputOrganizationAdd TillpostUpdate Till with Custom FieldsputGet Custom FieldsgetGet Config Key ValuesgetGet org till detailsgetGet Active TillsgetGet Loyalty ProgramsgetAdd StorepostRetrieve org hierarchy detailsgetUser GroupAdd GrouppostUpdate User GroupputSearch user groups by name, ID, and mobile numbergetDelete User GroupdeleteJoin Member to GrouppostRemove group memberdeleteTransfer Group MemberpostGet group transactionsgetRetrieve user group members listgetRetrieve user group members list with cards & status detailsgetRetrieve Primary & Secondary Member DetailsgetRetrieve group slab/tier log historygetRetrieve points expiry schedule of a groupgetRetrieve points conversion schedulegetStatus codesUpdate permissionsputCardsGenerate CardspostGet Card Generation LoggetAdd Card (Single)postUpdate Card Details (Single)putUpdate Card Details (Bulk)putGet Card DetailsgetGet Status LoggetLimit Active Cards per CustomerpostAdd Card Number to a Card SeriespostAdd External Reference ID to CardputPartner ProgramLink Customer to Partner ProgrampostUpdate CustomerpostDelink CustomerpostGet Customer ActivitygetGet customer activity historygetCompanyAdd CompanypostUpdate CompanyputGet Company DetailsgetRemove CompanydeleteGet Org CompaniesgetGet Companies by Extended Field ValuesgetBehavioral EventsCreate Event (Custom)postUpdate Event (Custom)putGet Org EventsgetGet Running Events StatusgetGet Customer EventsgetDisable EventputAdd WebhookpostGet Events LogsgetGet Events MetagetGet event data using request IDgetSearch eventsgetPost EventpostStaffAdd Staff AccountpostGet Access TokenpostEdit Staff DetailspostGet Staff DetailsgetChange Account PasswordpostSend OTPpostValidate OTPpostChange Identifier (Send OTP)postChange Identifier (Validate OTP)postTransfer Staff UserpostGet Staff of Store/ZonegetLogout Staff AccountgetRemove Staff AccountpostLeadsAdd LeadpatchAdd Lead SubstatuspostUpdate Lead StatusputUpdate Lead FollowupspostUpdate LeadputConfigure lead reasonspostGet Lead Status LoggetGet Lead follow-upsgetGet Lead ReasonsgetGet Lead DetailsgetGet Lead SubstatusgetAssign LeadgetSearch leadgetOther APIsGet Transaction EarninggetTrigger Walk-in Notifications on InStoregetUpdate Currency RatiopostGenerate Card/customer External IDgetConfigure Org Extended FieldpostGet Org Extended FieldsgetCreate Store AssociatespostFeed (Scan Event)postGet Configured Card Limit per CustomergetGet Org SourcesgetGet org configsgetRetrieve extended field config detailsgetPII deletionAdd a PII deletion requestpostUpdate PII deletion statusputRetrieve request status of PII deletiongetRetrieve PII deletion request detailsgetError codesRequestsAdd transaction requestpostUpdate transaction requestputRetrieve transaction request statusgetRetrieve transaction request detailsgetStatus event notificationError codesTransaction rejectiongetRejectedTransactionsgetgetReTriggerStatusgetmarkFailedputretriggerTransactionAddpostCommunicationsSend communication messagepostError codeReferralValidate Referral Codeget(New) Request workflowCreate a requestChange customer status requestpostPoints redemption requestpostIssue goodwill points requestpostIssue/Earn badge requestpostEnrol customers for badgespostRetro transaction - Claim transactionpostApprove or reject a requestputGet details of all requestsgetGet details of a particular requestgetError codesLoyalty PromotionEnrol a customer to loyalty promotionpostIssue loyalty promotion to customerspostGet promotion data of a specific customergetAudit logsGet audit logs of entitiesgetGet Audit Logs by event namegetv1.1 API ReferenceCustomerAdd CustomerpostUpdate customer detailspostUpdate Customer IdentifierpostSearch CustomersgetGet customer detailsgetGet Customer TransactionsgetGet Customer RedemptionsgetGet Customer CouponsgetAdd/Update Customer NotespostGet Customer NotesgetGet Product RecommendationsgetGet Customer InteractionsgetAdd TicketpostGet Ticket DetailsgetRefer CustomerpostGet Referral DetailsgetAdd/Update Customer PreferencespostGet Customer PreferencesgetUpdate Subscription DetailspostGet Subscription DetailsgetTransactionAdd TransactionpostAdd Transaction with Local CurrencypostUpdate Transaction DetailspostCancel Transaction LineitempostGet Transaction DetailsgetReturn TransactionpostRetro TransactionpostPointsCheck If Points RedeemablegetIssue Validation Code (to redeem points)getRedeem PointspostCouponIssue CouponpostResend CoupongetRedeem CouponpostGet Coupon detailsgetIs Coupon RedeemablegetGet Coupon series detailsgetCommunicationsSend communication messagepostError codeRequestAdd RequestpostApprove RequestspostReject RequestspostGet Request DetailsgetGet Request LogsgetTaskAdd TaskspostUpdate TaskspostGet Tasks MetadatagetGet Task LogsgetUpdate Status MappingspostGet Status MappingsgetGet Task RemindersgetCreate/Update Task ReminderspostRetrieve Individual Task DetailsgetOrganizationGet Org DetailsgetGet Org EntitiesgetGet Org ConfigurationsgetGet Org StatisticsgetGet Top Selling ItemsgetGet Org Custom FieldsgetRetrieve Brand IDpostGet Org Payment ModesgetStoreGet Store DetailsgetGet Store Staff DetailsgetGet Store TasksgetVerify Store Login CredentialsgetUpload Store LogspostUpload Store ReportspostGet Store ReportsgetGet Store ConfigurationsgetVerify Login CredentialsgetProductAdd ProductpostGet Product DetailsgetSearch ProductsgetAdd Product AttributespostGet Product AttributesgetGet Product CategoriesgetGet Product BrandsgetGet Product ColorsgetGet Product SizesgetGet Product Meta SizesgetResponse codesCustomer v1.1Customer Authentication (Web/Mobile)First factor authenticationGenerate Authentication TokenpostGenerate OTPpostValidate OTPpostValidate PasswordpostRegenerate Authentication TokenpostChange PasswordpostForget PasswordpostStatus codesMulti-factor authenticationGenerate MFA tokenpostGenerate MFA OTPpostValidate MFA OTPpostMFA password flowValidate passwordpostChange passwordpostForgot passwordpostRegenerate tokenpostDelete tokendeleteAuthentication configurationsChange identifier on Auth enginepostLoyalty PromotionsGet details of all promotionsgetGet promotion by IDgetCoupon UploadUpload Coupons (Batch)postUpload Redeemed CouponspostGet Uploaded Coupons' StatusgetGet Status of Redeemed CouponsgetRecommendationsGet User RecommendationsgetGet Item RecommendationsgetGet Cart RecommendationsgetCart PromotionsGet Promotion SettingsgetGet Promotion RedemptionsgetGet Promotion DetailsgetGet Promotions code APIgetGet Promotions for a particular tillgetGET Lock unlock -Pending cartsgetGet Promotions Config APIgetCreate PromotionpostSet Promotion SettingspostEarn PromotionpostDeactivate PromotionpostActivate PromotionpostPost Revoke Earned PromotionpostPost Earn Promotions in BulkpostPost Evaluate PromotionspostPost Cancel Cart EvaluationpostPost Promotions Code link APIpostGet Promotions for a CustomergetUpdate promotion detailsgetRewards CatalogCreate rewardpostAdding revenue metadata against a rewardUpdate RewardputClaim RewardputIssue single rewardpostReward Issuance with Quantity DetailsIssue bulk rewardpostGet all brand rewardsgetGet all brand rewards based on ownergetGet reward details by IDgetGet brand rewardsgetGet purchased rewards for user (Old API)getGet purchased rewards for user (New API)getGet purchased reward details by id and usergetGet all available rewards for usergetGet available reward details for user by idgetGet all transactions for the usergetGet transaction details by id and customergetCreate catalog promotionpostUpdate catalog promotionputGet catalog promotion detailsgetGet list of promotionsgetDisable promotionputGet available brand rewardsgetCreate custom fieldpostUpdate custom fieldputGet custom fieldgetCreate reward grouppostUpdate rewards groupputGet rewards groupgetGet rewards group by IDgetCreate points restrictionpostUpdate points restrictionputGet points constraintsgetSet start day of the weekpostCreate vendor redemptionpostGet customer reward transaction by IDgetUpload images to file servicepostCreate fulfillment statuspostUpdate fulfillment statusputGet fulfillment statusgetUpdate fulfilment status and transaction custom fields for issued rewardsputMeta searchPerform searchpostBadgesCreate badgespostFixed Window Restriction in BadgesUpdate badgesputGet badge by IDgetGet all badgesgetGet fixed window detailsgetClaim badgepostUnclaim badgepostUpdate activation status of badgeputEnrol customers for badgespostIssue badge (earn)postIssue badge to multiple customerspostImport earned (issued) badges of customerpostRevoke enrolled badgespostRevoke issued badgepostGet badges for customergetGet all customer badgesgetGet individual badge details of a customergetCreate badges grouppostUpdate badges groupputGet group by IDgetGet all groupsgetCreate custom fieldpostUpdate custom fieldputGet custom field by IDputGet all custom fieldsgetPowered by Audit logsGet audit logs of entities Get Audit Logs by event name
