# Capillary Documentation Documentation

> Documentation for Capillary Documentation

## User Documentation: GETTING STARTED
- [Introduction](https://docs.capillarytech.com/docs/introduction.md)
- [Getting Started with Capillary](https://docs.capillarytech.com/docs/getting-started-with-capillary.md)
- [Accessing Capillary](https://docs.capillarytech.com/docs/accessing-capillary.md): This section provides the different ways of accessing InTouch.
- [Explore Intouch Navigation](https://docs.capillarytech.com/docs/explore-intouch-navigation.md)

## User Documentation: aiRA
- [Introduction to aiRA](https://docs.capillarytech.com/docs/aira-introduction.md)
  - [Overview of aiRA](https://docs.capillarytech.com/docs/introduction-to-aira.md)
  - [What aiRA can do](https://docs.capillarytech.com/docs/what-aira-can-do.md)
  - [How aiRA works](https://docs.capillarytech.com/docs/how-aira-works.md)
  - [Glossary](https://docs.capillarytech.com/docs/glossary.md)
  - [FAQs](https://docs.capillarytech.com/docs/faqs.md)
- [Get started with aiRA](https://docs.capillarytech.com/docs/getting-started.md)
  - [The aiRA workspace at a glance](https://docs.capillarytech.com/docs/workspace-at-a-glance.md)
  - [Start a chat and ask your first question](https://docs.capillarytech.com/docs/start-a-chat.md)
- [Chat with aiRA](https://docs.capillarytech.com/docs/chatting.md)
  - [Attach a file to your request](https://docs.capillarytech.com/docs/attach-files.md)
  - [Use voice input](https://docs.capillarytech.com/docs/voice-input.md)
  - [Follow aiRA's work](https://docs.capillarytech.com/docs/follow-aira-work.md)
  - [Find, reopen, and manage past chats](https://docs.capillarytech.com/docs/find-and-manage-chats.md)
  - [Share a chat with a teammate](https://docs.capillarytech.com/docs/share-a-chat.md)
  - [FAQs](https://docs.capillarytech.com/docs/chatting-faqs.md)
- [Review](https://docs.capillarytech.com/docs/review.md)
  - [What artifacts are](https://docs.capillarytech.com/docs/what-artifacts-are.md)
  - [The review view explained](https://docs.capillarytech.com/docs/review-view.md)
  - [Create a configuration](https://docs.capillarytech.com/docs/create-a-configuration.md)
  - [Read QA test results](https://docs.capillarytech.com/docs/qa-test-results.md)
  - [FAQs](https://docs.capillarytech.com/docs/review-faqs.md)
- [Ask aiRA about your data](https://docs.capillarytech.com/docs/analytics.md)
  - [Asking aiRA about your data](https://docs.capillarytech.com/docs/analytics-introduction.md)
  - [Ask a data question](https://docs.capillarytech.com/docs/ask-a-data-question.md)
  - [Read results and the query](https://docs.capillarytech.com/docs/read-results.md)
  - [Run an RFM analysis](https://docs.capillarytech.com/docs/rfm-analysis.md)
  - [FAQs](https://docs.capillarytech.com/docs/analytics-faqs.md)
- [Build with aiRA](https://docs.capillarytech.com/docs/building.md)
  - [Audiences with aiRA](https://docs.capillarytech.com/docs/audiences-with-aira.md)
  - [Badges with aiRA](https://docs.capillarytech.com/docs/badges-with-aira.md)
  - [Campaigns and messages with aiRA](https://docs.capillarytech.com/docs/campaigns-and-messages-with-aira.md)
  - [Cart promotions with aiRA](https://docs.capillarytech.com/docs/cart-promotions-with-aira.md)
  - [Coupons with aiRA](https://docs.capillarytech.com/docs/coupons-with-aira.md)
  - [Gift vouchers with aiRA](https://docs.capillarytech.com/docs/gift-vouchers-with-aira.md)
  - [Journeys with aiRA](https://docs.capillarytech.com/docs/journeys-with-aira.md)
  - [Message templates with aiRA](https://docs.capillarytech.com/docs/message-templates-with-aira.md)
  - [Milestones and streaks with aiRA](https://docs.capillarytech.com/docs/milestones-and-streaks-with-aira.md)
  - [Promotions with aiRA](https://docs.capillarytech.com/docs/promotions-with-aira.md)
  - [Rewards catalog with aiRA](https://docs.capillarytech.com/docs/rewards-catalog-with-aira.md)
- [Generate content with aiRA](https://docs.capillarytech.com/docs/generating.md)
  - [Generate or edit an image with aiRA](https://docs.capillarytech.com/docs/generate-or-edit-an-image.md)
  - [Turn a design into an email creative with aiRA](https://docs.capillarytech.com/docs/email-creative-from-a-design.md)
  - [Create a PDF report with aiRA](https://docs.capillarytech.com/docs/create-a-pdf-report.md)
  - [Create a PowerPoint deck with aiRA](https://docs.capillarytech.com/docs/create-a-powerpoint-deck.md)
  - [Generating content with aiRA: FAQs](https://docs.capillarytech.com/docs/generating-faqs.md)
- [Apps with aiRA](https://docs.capillarytech.com/docs/apps.md)
  - [Introduction to apps](https://docs.capillarytech.com/docs/introduction-to-apps.md)
  - [Build and deploy an app](https://docs.capillarytech.com/docs/build-and-deploy-an-app.md)
  - [Share and manage an app](https://docs.capillarytech.com/docs/share-and-manage-an-app.md)
  - [Open and use an app](https://docs.capillarytech.com/docs/open-and-use-an-app.md)
  - [Apps with aiRA: FAQs](https://docs.capillarytech.com/docs/apps-faqs.md)
- [Contexts with aiRA](https://docs.capillarytech.com/docs/contexts.md)
  - [Introduction to contexts](https://docs.capillarytech.com/docs/introduction-to-contexts.md)
  - [Create and edit a context](https://docs.capillarytech.com/docs/create-and-edit-a-context.md)
  - [Add files and images to a context](https://docs.capillarytech.com/docs/add-files-and-images.md)
  - [Store credentials as Context Keys](https://docs.capillarytech.com/docs/store-credentials-as-context-keys.md)
  - [The sensitive-data scan](https://docs.capillarytech.com/docs/the-sensitive-data-scan.md)
  - [How aiRA uses contexts](https://docs.capillarytech.com/docs/how-aira-uses-contexts.md)
  - [Contexts with aiRA: FAQs](https://docs.capillarytech.com/docs/contexts-faqs.md)
- [Playbooks with aiRA](https://docs.capillarytech.com/docs/playbooks.md)
  - [Introduction to playbooks](https://docs.capillarytech.com/docs/introduction-to-playbooks.md)
  - [Find and try a playbook](https://docs.capillarytech.com/docs/find-and-try-a-playbook.md)
  - [Turn a playbook on or off](https://docs.capillarytech.com/docs/turn-a-playbook-on-or-off.md)
  - [Create and manage a playbook](https://docs.capillarytech.com/docs/create-and-manage-a-playbook.md)
  - [Playbooks with aiRA: FAQs](https://docs.capillarytech.com/docs/playbooks-faqs.md)
  - [Managed playbook library](https://docs.capillarytech.com/docs/managed.md)
    - [Global Playbook Catalog](https://docs.capillarytech.com/docs/global-playbook-catalog.md)
    - [Playbook: Campaign Strategy](https://docs.capillarytech.com/docs/campaign-strategy.md)
    - [Playbook: DQR (Data Quality Report)](https://docs.capillarytech.com/docs/data-quality-report.md)
    - [Playbook: Fraud Detection](https://docs.capillarytech.com/docs/fraud-detection.md)
    - [Playbook: RCA Deep Dive](https://docs.capillarytech.com/docs/rca-deep-dive.md)
    - [Playbook: Reconciliation](https://docs.capillarytech.com/docs/reconciliation.md)
    - [Playbook: Smart Journeys](https://docs.capillarytech.com/docs/smart-journeys.md)
    - [Playbook: ML Guide](https://docs.capillarytech.com/docs/ml-guide.md)
    - [Playbook: Promotion Effectiveness Analysis](https://docs.capillarytech.com/docs/promotion-effectiveness-analysis.md)
    - [Playbook: Promotional Lift by Category](https://docs.capillarytech.com/docs/promotional-lift-by-category.md)
    - [Playbook: Coupon Issuance & Redemption Funnel](https://docs.capillarytech.com/docs/coupon-issuance-redemption-funnel.md)
    - [Playbook: Reward/Coupon Performance](https://docs.capillarytech.com/docs/reward-coupon-performance.md)
    - [Playbook: End-of-Season Sale (EOSS) Impact Report](https://docs.capillarytech.com/docs/eoss-impact-report.md)
    - [Playbook: Journey Performance](https://docs.capillarytech.com/docs/journey-performance.md)
    - [Playbook: Journey Strategy](https://docs.capillarytech.com/docs/journey-strategy.md)
    - [Playbook: Points Economy Health Report](https://docs.capillarytech.com/docs/points-economy-health-report.md)
    - [Playbook: Points Accounting](https://docs.capillarytech.com/docs/points-accounting.md)
    - [Playbook: Points Expiry Forecasting & Liability Report](https://docs.capillarytech.com/docs/points-expiry-forecasting.md)
    - [Playbook: Points Deduction Tracing](https://docs.capillarytech.com/docs/points-deduction-tracing.md)
    - [Playbook: Points Transfer Analysis](https://docs.capillarytech.com/docs/points-transfer-analysis.md)
    - [Playbook: Waterfall Reporting (Points and Sales)](https://docs.capillarytech.com/docs/waterfall-reporting-points-sales.md)
    - [Playbook: Tier Distribution & Movement Analysis](https://docs.capillarytech.com/docs/tier-distribution-movement.md)
    - [Playbook: Tier Upgrade/Downgrade Funnel](https://docs.capillarytech.com/docs/tier-upgrade-downgrade-funnel.md)
    - [Playbook: Milestone & Streak Completion Analysis](https://docs.capillarytech.com/docs/milestone-streak-completion.md)
    - [Playbook: Badges Performance](https://docs.capillarytech.com/docs/badges-performance.md)
    - [Playbook: Incrementality Analysis](https://docs.capillarytech.com/docs/incrementality-analysis.md)
    - [Playbook: Call Task & Customer Service Analytics](https://docs.capillarytech.com/docs/call-task-cs-analytics.md)
    - [Playbook: Issue Tracker / Complaints Analysis](https://docs.capillarytech.com/docs/issue-complaints-analysis.md)
    - [Playbook: Outlier / Anomaly Transaction Detection](https://docs.capillarytech.com/docs/anomaly-transaction-detection.md)
    - [Playbook: Customer Merge & Dedup Audit](https://docs.capillarytech.com/docs/customer-merge-dedup-audit.md)
    - [Playbook: Basket Affinity / Market Basket Analysis](https://docs.capillarytech.com/docs/basket-affinity-analysis.md)
    - [Playbook: Basket Composition & Category Mix Analysis](https://docs.capillarytech.com/docs/basket-composition-category-mix.md)
    - [Playbook: Cross-Category Buying Patterns](https://docs.capillarytech.com/docs/cross-category-buying-patterns.md)
    - [Playbook: Multi-Brand Portfolio Cross-Sell](https://docs.capillarytech.com/docs/multi-brand-portfolio-cross-sell.md)
    - [Playbook: New Arrival Adoption Curve](https://docs.capillarytech.com/docs/new-arrival-adoption-curve.md)
    - [Playbook: Seasonal Collection Performance](https://docs.capillarytech.com/docs/seasonal-collection-performance.md)
    - [Playbook: Returns & Refund Analysis](https://docs.capillarytech.com/docs/returns-refund-analysis.md)
    - [Playbook: Sales Performance Dashboard](https://docs.capillarytech.com/docs/sales-performance-dashboard.md)
    - [Playbook: Store-Level Performance Benchmarking](https://docs.capillarytech.com/docs/store-performance-benchmarking.md)
    - [Playbook: Channel Mix Analysis](https://docs.capillarytech.com/docs/channel-mix-analysis.md)
    - [Playbook: Time-Series Trend Analysis](https://docs.capillarytech.com/docs/time-series-trend-analysis.md)
    - [Playbook: Weekday vs Weekend Shopping Patterns](https://docs.capillarytech.com/docs/weekday-weekend-patterns.md)
    - [Playbook: Payment Mode Analysis](https://docs.capillarytech.com/docs/payment-mode-analysis.md)
    - [Playbook: Cashier Performance Analysis](https://docs.capillarytech.com/docs/cashier-performance-analysis.md)
    - [Playbook: Campaign Performance Dashboard](https://docs.capillarytech.com/docs/campaign-performance-dashboard.md)
    - [Playbook: Campaign ROI & Incremental Lift](https://docs.capillarytech.com/docs/campaign-roi-incremental-lift.md)
    - [Playbook: Campaign Group Performance Comparison](https://docs.capillarytech.com/docs/campaign-group-performance.md)
    - [Playbook: Channel Effectiveness Comparison](https://docs.capillarytech.com/docs/channel-effectiveness-comparison.md)
    - [Playbook: Referral Program Performance](https://docs.capillarytech.com/docs/referral-program-performance.md)
    - [Playbook: Communications Consumption Report](https://docs.capillarytech.com/docs/communications-consumption-report.md)
    - [Playbook: Communication Credit Consumption](https://docs.capillarytech.com/docs/communication-credit-consumption.md)
    - [Playbook: Email Click Heatmap & Link Performance](https://docs.capillarytech.com/docs/email-click-heatmap.md)
    - [Playbook: Unsubscription / Opt-Out Trend Analysis](https://docs.capillarytech.com/docs/unsubscription-optout-trend.md)
    - [Playbook: RFM Segmentation & Migration Analysis](https://docs.capillarytech.com/docs/rfm-segmentation.md)
    - [Playbook: Customer Lifecycle Analysis](https://docs.capillarytech.com/docs/customer-lifecycle-analysis.md)
    - [Playbook: Cohort Analysis](https://docs.capillarytech.com/docs/cohort-analysis.md)
    - [Playbook: Customer Retention & Repeat Rate Analysis](https://docs.capillarytech.com/docs/retention-repeat-rate.md)
    - [Playbook: Loyalty Penetration Rate](https://docs.capillarytech.com/docs/loyalty-penetration-rate.md)
    - [Playbook: Customer Lifetime Value (CLV) Modeling](https://docs.capillarytech.com/docs/clv-modeling.md)
    - [Playbook: Propensity Modeling](https://docs.capillarytech.com/docs/propensity-modeling.md)
    - [Playbook: Next Best Action / Offer Recommendation](https://docs.capillarytech.com/docs/next-best-action.md)
    - [Playbook: Customer Look-Alike Modeling](https://docs.capillarytech.com/docs/customer-lookalike-modeling.md)
    - [Playbook: Style Preference Clustering](https://docs.capillarytech.com/docs/style-preference-clustering.md)
    - [Playbook: Customer Demographics Profiling](https://docs.capillarytech.com/docs/customer-demographics-profiling.md)
    - [Playbook: Customer 360 Profile Report](https://docs.capillarytech.com/docs/customer-360-profile.md)
    - [Playbook: Purchase Frequency & Replenishment Cycle](https://docs.capillarytech.com/docs/purchase-frequency-replenishment.md)
    - [Playbook: Registration Funnel & Source Analysis](https://docs.capillarytech.com/docs/registration-funnel-source.md)
    - [Playbook: Lead Management Funnel](https://docs.capillarytech.com/docs/lead-management-funnel.md)
- [Email preview](https://docs.capillarytech.com/docs/email-preview.md)
  - [Email preview](https://docs.capillarytech.com/docs/email-preview-with-aira.md)
  - [Email preview: FAQs](https://docs.capillarytech.com/docs/email-preview-faqs.md)
- [Connect external data](https://docs.capillarytech.com/docs/external-data.md)
  - [Connecting external data](https://docs.capillarytech.com/docs/connecting-external-data.md)
  - [Add and manage whitelisted URLs](https://docs.capillarytech.com/docs/add-and-manage-whitelisted-urls.md)
  - [Connecting external data: FAQs](https://docs.capillarytech.com/docs/external-data-faqs.md)
- [Usage and billing](https://docs.capillarytech.com/docs/usage-and-billing.md)
  - [Introduction to credits](https://docs.capillarytech.com/docs/introduction-to-credits.md)
  - [View usage and the credit ledger](https://docs.capillarytech.com/docs/view-usage-and-the-credit-ledger.md)
  - [Set usage limits and alerts](https://docs.capillarytech.com/docs/set-usage-limits-and-alerts.md)
  - [Track adoption with usage trends](https://docs.capillarytech.com/docs/track-adoption-with-usage-trends.md)
  - [Usage and billing: FAQs](https://docs.capillarytech.com/docs/usage-and-billing-faqs.md)
- [Roles and permissions](https://docs.capillarytech.com/docs/roles-and-permissions.md)
  - [Roles and permissions](https://docs.capillarytech.com/docs/roles-and-permissions-overview.md)
  - [aiRA permission sets](https://docs.capillarytech.com/docs/aira-permission-sets.md)
  - [Settings access by role](https://docs.capillarytech.com/docs/settings-access-by-role.md)
  - [Roles and permissions: FAQs](https://docs.capillarytech.com/docs/roles-and-permissions-faqs.md)
- [Sample use cases](https://docs.capillarytech.com/docs/aira-use-cases.md)
  - [Sample use cases](https://docs.capillarytech.com/docs/sample-use-cases.md)
  - [Launch a campaign end-to-end with aiRA](https://docs.capillarytech.com/docs/launch-a-campaign-end-to-end.md)
  - [Get a quick answer from your data](https://docs.capillarytech.com/docs/get-a-quick-answer-from-your-data.md)
  - [Diagnose a sales dip with aiRA](https://docs.capillarytech.com/docs/diagnose-a-sales-dip.md)
  - [Find at-risk customers and win them back](https://docs.capillarytech.com/docs/find-and-win-back-at-risk-customers.md)
  - [Onboard new members with a journey](https://docs.capillarytech.com/docs/onboard-new-members-with-a-journey.md)
  - [Drive repeat visits with a milestone challenge](https://docs.capillarytech.com/docs/drive-repeat-visits-with-a-milestone-challenge.md)
  - [Reward a segment with a coupon offer](https://docs.capillarytech.com/docs/reward-a-segment-with-a-coupon-offer.md)
  - [Create on-brand marketing content](https://docs.capillarytech.com/docs/create-on-brand-marketing-content.md)
  - [Build a leadership dashboard with aiRA](https://docs.capillarytech.com/docs/build-a-leadership-dashboard.md)
  - [Put together a quarterly business review](https://docs.capillarytech.com/docs/put-together-a-quarterly-business-review.md)
  - [See whether a campaign paid off](https://docs.capillarytech.com/docs/see-whether-a-campaign-paid-off.md)
  - [Run a data-quality check before an import](https://docs.capillarytech.com/docs/run-a-data-quality-check.md)
  - [Answer a member's points question](https://docs.capillarytech.com/docs/answer-a-members-points-question.md)
- [Reference and help](https://docs.capillarytech.com/docs/reference-and-help.md)
  - [Trust and safety](https://docs.capillarytech.com/docs/trust-safety.md)
    - [Trust and safety](https://docs.capillarytech.com/docs/trust-and-safety.md)
    - [Trust and safety: FAQs](https://docs.capillarytech.com/docs/trust-safety-faqs.md)
  - [Capabilities and limits](https://docs.capillarytech.com/docs/capabilities.md)
    - [What aiRA can and cannot do](https://docs.capillarytech.com/docs/what-aira-can-and-cannot-do.md)
    - [What aiRA cannot do, and what to do instead](https://docs.capillarytech.com/docs/what-aira-cannot-do.md)
  - [Reference](https://docs.capillarytech.com/docs/reference.md)
    - [Reference](https://docs.capillarytech.com/docs/reference-guide.md)
    - [Master glossary](https://docs.capillarytech.com/docs/master-glossary.md)
  - [FAQs and troubleshooting](https://docs.capillarytech.com/docs/faqs-troubleshooting.md)
    - [Troubleshooting](https://docs.capillarytech.com/docs/aira-troubleshooting.md)
    - [FAQs](https://docs.capillarytech.com/docs/aira-faqs.md)

## User Documentation: CAPILLARY DATA PLATFORM
- [Entities ](https://docs.capillarytech.com/docs/data-entities.md): An entity refers to a specific object, like a customer, product, or transaction, that has its own unique details in a system or situation.
  - [Customers](https://docs.capillarytech.com/docs/customer-entities-management.md): Manage customer labels, statuses, registration, and subscription configurations from the self-serve Customers entity page.
  - [Customer entity](https://docs.capillarytech.com/docs/customer_entity.md): This page provides you with information on customer entity
  - [Transactions](https://docs.capillarytech.com/docs/set-transactions.md)
  - [Products](https://docs.capillarytech.com/docs/product-entities-management.md): Create and manage your organization's SKUs, Brands, Categories, Attributes, Labels, and Collections from a single self-serve Products page.
  - [Product (Old)](https://docs.capillarytech.com/docs/product.md)
  - [Locations](https://docs.capillarytech.com/docs/locations-entities-management.md): Create and manage your organization's  business location, geographic grouping, business grouping, and point of transaction from a single self-serve Locations page.
    - [Setup Store hierarchy (Old)](https://docs.capillarytech.com/docs/store-hierarchy.md)
  - [Data Fields](https://docs.capillarytech.com/docs/data-fields.md)
    - [Standard Fields](https://docs.capillarytech.com/docs/standard-fields.md)
    - [Extended Fields](https://docs.capillarytech.com/docs/extended-fields.md)
    - [Custom Fields](https://docs.capillarytech.com/docs/entity-management-custom-fields.md)
  - [Payment modes](https://docs.capillarytech.com/docs/payment-modes.md)
  - [Behavioral events](https://docs.capillarytech.com/docs/setup-test-behavioral-events.md)
  - [Cards](https://docs.capillarytech.com/docs/card.md)
  - [Setup User Groups](https://docs.capillarytech.com/docs/user-group.md)
  - [Group Hierarchy](https://docs.capillarytech.com/docs/hierarchy.md)
  - [Create Search Filter for Entities](https://docs.capillarytech.com/docs/create-search-filter.md)
    - [Use Cases](https://docs.capillarytech.com/docs/use-case-search-filter.md)
    - [Overview](https://docs.capillarytech.com/docs/overview-search-filter.md)
    - [Create a Search Filter](https://docs.capillarytech.com/docs/create-search-filter-.md)
    - [Perform Search](https://docs.capillarytech.com/docs/performing-search-.md)
    - [FAQs](https://docs.capillarytech.com/docs/search-filter-faq.md)
- [Dataflow ](https://docs.capillarytech.com/docs/connect-plus.md): (Formerly known as Connect+). Dataflow is Capillary's no-code data integration platform for building, managing, and monitoring data pipelines.
  - [Overview](https://docs.capillarytech.com/docs/connectplus-overview.md): What Connect+ is, what you can do with it, and how it compares to Data Import.
  - [Use Cases](https://docs.capillarytech.com/docs/connectplus-use-cases.md): End-to-end dataflow examples for common integration scenarios in Connect+.
  - [Access Connect+](https://docs.capillarytech.com/docs/enabling-managing-access-to-connect.md): Access, prerequisites, and how to manage users and workspace access in Connect+.
  - [Introduction to the UI](https://docs.capillarytech.com/docs/ui-introduction.md): A guide to navigating the Connect+ interface — the home page, dataflow list, workspace selector, performance metrics, and settings.
  - [Getting Started](https://docs.capillarytech.com/docs/connectplus-getting-started.md): How to create your first dataflow in Connect+ — selecting a template, configuring blocks, and running the flow.
  - [Core Concepts](https://docs.capillarytech.com/docs/core-concepts-connectplus.md): Key terms and concepts in Connect+ — workspace, dataflow, template, and building block.
  - [Create and Manage Connect+ Dataflows](https://docs.capillarytech.com/docs/creating-and-managing-connect-dataflows.md): How to create and manage dataflow
  - [View and Organize Dataflows](https://docs.capillarytech.com/docs/view-and-organize-dataflows.md)
  - [Explore Templates](https://docs.capillarytech.com/docs/connect-explore-templates.md): Browse Connect+ templates by category — data ingestion, loyalty and rewards, audience and campaigns, file transfer, and data management.
    - [Data Ingestion](https://docs.capillarytech.com/docs/data-ingestion.md): Templates for ingesting customer, transaction, event, and user data into the Capillary platform.
    - [Audience & Campaigns](https://docs.capillarytech.com/docs/audience-campaigns.md): Templates for syncing audience data and reloading campaign segments from SFTP.
    - [File Transfer & Transformation](https://docs.capillarytech.com/docs/file-transfer-transformation.md): Templates for transferring files between SFTP, FTP, and S3, with optional header manipulation, file joins, and format conversion.
    - [Data Management](https://docs.capillarytech.com/docs/data-management.md): Templates for data reconciliation, PII cleanup, customer status updates, and triggering Databricks jobs.
    - [Loyalty and Rewards](https://docs.capillarytech.com/docs/loyalty-and-rewards.md): Templates for creating and updating loyalty rewards in bulk in the Capillary platform.
  - [Building Block Configuration](https://docs.capillarytech.com/docs/connect-building-block-configuration.md): Configuration reference for every Connect+ block — fields, purpose, and usage notes.
    - [Trigger block](https://docs.capillarytech.com/docs/trigger-block.md): Define how this dataflow will be triggered
    - [SFTP (Read) block ](https://docs.capillarytech.com/docs/sftp-read-block.md): Configuration reference for the Connect to Source block — polls an SFTP or FTP server and downloads files for processing.
    - [SFTP (Write) block](https://docs.capillarytech.com/docs/sftp-write-block.md)
    - [S3 (Read) block](https://docs.capillarytech.com/docs/s3-read-block.md)
    - [S3 (Write) block](https://docs.capillarytech.com/docs/s3_write-block.md)
    - [Kafka (Read) block](https://docs.capillarytech.com/docs/kafka-read-block.md)
    - [Kafka (Write) block](https://docs.capillarytech.com/docs/kafka-write-block.md)
    - [Transform (CSV to JSON) block](https://docs.capillarytech.com/docs/transform-csv-to-json-block.md)
    - [Transform (CSV to XML) block](https://docs.capillarytech.com/docs/transform-csv-to-xml-block.md)
    - [PGP Decrypt block](https://docs.capillarytech.com/docs/pgp-decrypt-block.md): Configuration reference for the Decrypt Data block — decrypts encrypted source files before processing.
    - [PGP Encrypt block](https://docs.capillarytech.com/docs/pgp-encrypt-block.md): Configuration reference for the Encrypt Data block — encrypts the output file before it is transferred to the destination.
    - [Databricks (Validation) block](https://docs.capillarytech.com/docs/databricks-validation-block.md): Configuration reference for the Data Validation block — runs a Databricks notebook to clean, validate, and transform source data before ingestion.
    - [API request (http_write) block](https://docs.capillarytech.com/docs/api-request-http_write-block.md)
    - [Filter block](https://docs.capillarytech.com/docs/filter-block.md)
    - [Event notification (Read) block](https://docs.capillarytech.com/docs/event-notification-read-block.md)
    - [Hashing (CSV) block](https://docs.capillarytech.com/docs/hashing-csv-block.md)
    - [Iris Audience Refresh (FTP) block](https://docs.capillarytech.com/docs/iris-audience-refresh-ftp-block.md)
    - [JSLT block](https://docs.capillarytech.com/docs/jslt-block.md)
    - [Split block](https://docs.capillarytech.com/docs/split-block.md)
    - [Transform (Headers) block](https://docs.capillarytech.com/docs/transform-headers-block.md)
    - [Cron block](https://docs.capillarytech.com/docs/cron-block.md)
    - [Arya call block](https://docs.capillarytech.com/docs/arya-call-block.md)
    - [Hash CSV Fields](https://docs.capillarytech.com/docs/hash-csv-fields.md): Configuration reference for the Hash CSV Fields block — masks sensitive columns in a CSV by replacing values with a cryptographic hash.
  - [aiRA Coder](https://docs.capillarytech.com/docs/aira-coder.md): Know what aiRA coder is and it's capabilities
  - [Monitoring and Observability in Connect+](https://docs.capillarytech.com/docs/monitoring-and-observability-in-connect.md): How to view dataflow run status, performance metrics, block-wise breakdowns, error logs, and configure alerts in Connect+.
  - [Troubleshooting](https://docs.capillarytech.com/docs/troubleshooting.md): Common errors by block, how to use error logs, and links to the error documentation reference.
  - [FAQs](https://docs.capillarytech.com/docs/connectplus-faqs.md): Frequently asked questions about Connect+.
- [Overview](https://docs.capillarytech.com/docs/connectplus_overview.md): This page provides you an overview about Connect+.
- [Getting started](https://docs.capillarytech.com/docs/connectplus_getting_started.md): This page provides you with information on geting started with Connect+.
- [Using  expressions for data transformation](https://docs.capillarytech.com/docs/know-about-expressions-in-connect.md): This page provides you with information on expressions that you can use in Connect+ actions.
- [Configure blocks](https://docs.capillarytech.com/docs/configure-blocks-connectplus.md): This page provides you with information on configuring blocks in Connect+.
  - [Connect to Source](https://docs.capillarytech.com/docs/connect-to-source.md)
  - [Connect to Source - Kafka](https://docs.capillarytech.com/docs/configuring-ingest-kafka-stream-in-api.md)
  - [Decrypt Data](https://docs.capillarytech.com/docs/decrypt-data.md)
  - [Connect to Destination](https://docs.capillarytech.com/docs/connect-to-destination.md)
  - [Transform Data](https://docs.capillarytech.com/docs/transform-data.md)
  - [Join Data](https://docs.capillarytech.com/docs/join-data.md)
  - [CSV-To-XML-Converter](https://docs.capillarytech.com/docs/csv-to-xml-converter.md)
  - [Push to S3](https://docs.capillarytech.com/docs/push-to-s3.md)
  - [Encrypt Data](https://docs.capillarytech.com/docs/encrypt-data.md)
  - [Schedule Trigger](https://docs.capillarytech.com/docs/schedule-trigger.md)
  - [Rebuild Headers / Define Headers and Transform Data](https://docs.capillarytech.com/docs/rebuild-headers-define-headers-and-transform-data.md)
  - [Mask Contents in a CSV](https://docs.capillarytech.com/docs/mask-contents-in-a-csv.md)
  - [Invoke Neo Iteratively](https://docs.capillarytech.com/docs/invoke-neo-iteratively.md)
  - [Convert JSON to CSV/Avro Format](https://docs.capillarytech.com/docs/convert-json-to-csvavro-format.md)
  - [Convert CSV to JSON](https://docs.capillarytech.com/docs/convert-csv-to-json.md)
  - [Event Notification Block](https://docs.capillarytech.com/docs/event-notification-block-.md)
  - [Neo Transformer V2 Block](https://docs.capillarytech.com/docs/neo-transformer-v2-block.md)
  - [Connect to Destination without OAuth or S3 Pull Block](https://docs.capillarytech.com/docs/connect-to-destination-block-without-oauth-authentication.md)
  - [Neo Transformer Block](https://docs.capillarytech.com/docs/neo-transformer-block.md)
  - [Data Validation Block](https://docs.capillarytech.com/docs/data-validation-block.md)
- [Explore templates](https://docs.capillarytech.com/docs/explore-templates.md): This page provides you with information on templates available in Connect+.
  - [Test and control template](https://docs.capillarytech.com/docs/test_and_control.md)
  - [Add transaction template](https://docs.capillarytech.com/docs/add_transaction.md)
  - [File transfer templates](https://docs.capillarytech.com/docs/file-transfer-templates.md)
  - [Data reconciliation template](https://docs.capillarytech.com/docs/data_reconciliation_template.md)
  - [Transaction line item merge template](https://docs.capillarytech.com/docs/transaction-line-item-merge.md): This page provides you with information on transaction line item merge template.
  - [PII cleanup template](https://docs.capillarytech.com/docs/pii_cleanup_template.md)
  - [Add customer template](https://docs.capillarytech.com/docs/add-customer-template.md): This template enables you to add customers in bulk.
  - [Create or update Badges](https://docs.capillarytech.com/docs/create_badges.md): This template enables you to create and update Badges.
  - [Import Earned Badges of Customer in Bulk](https://docs.capillarytech.com/docs/import-earned-badges-of-customer-template.md)
  - [CSV to XML conversion template](https://docs.capillarytech.com/docs/csv_to_xml_conversion.md)
  - [Coupon redeem template](https://docs.capillarytech.com/docs/coupon-redeem.md)
  - [Workspace & user management](https://docs.capillarytech.com/docs/workspace-user-management.md): This page provides information about creation, modification and deletion of workspace and users in Connect+.
  - [Audience Reload from FTP](https://docs.capillarytech.com/docs/audience-reload-from-ftp.md): This page provides you with information on the Audience Reload from FTP template.
  - [Onboard users to Intouch](https://docs.capillarytech.com/docs/onboard-users-to-intouch.md): This page provides you with information on the Onboarding users to Intouch.
  - [Card update template](https://docs.capillarytech.com/docs/card-update-template.md)
  - [Fleet customers template](https://docs.capillarytech.com/docs/fleet-customers-template.md)
  - [FTP to S3](https://docs.capillarytech.com/docs/ftp-to-s3.md): This template enables you to transfer files from a FTP server to S3 server.
  - [Behavioural events ingestion](https://docs.capillarytech.com/docs/behavioural-events-ingestion.md)
  - [Goodwill points issue template](https://docs.capillarytech.com/docs/goodwill-points-issue-template.md)
  - [Earned badges for customer template](https://docs.capillarytech.com/docs/earned-badges-for-customer-template.md)
  - [Retro transaction template](https://docs.capillarytech.com/docs/retro-transaction-template.md)
  - [Create Rewards Template](https://docs.capillarytech.com/docs/create-rewards_connectplus-template.md)
  - [Update Rewards Template](https://docs.capillarytech.com/docs/update-reward-connectplus.md)
  - [Force generate barcode template](https://docs.capillarytech.com/docs/force-generate-barcode-template.md)
  - [Databricks job trigger template](https://docs.capillarytech.com/docs/connectplus-databricks-job-trigger-template.md)
  - [SFTP to SFTP with Headers Definition](https://docs.capillarytech.com/docs/sftp-to-sftp-with-headers-definition.md)
  - [Ingest Kafka Stream in API](https://docs.capillarytech.com/docs/ingest-kafka-stream-in-api.md)
  - [Pull Data from API](https://docs.capillarytech.com/docs/pull-data-from-api.md)
- [Analyse dataflow performance](https://docs.capillarytech.com/docs/analyse-dataflow-performance.md): This page provides you with information on analysing the performance of the dataflow created.
- [Troubleshooting guide](https://docs.capillarytech.com/docs/troubleshooting-guide-connectplus.md): This page provides information on troubleshooting generic Connect+ errors.
- [DIY Templates](https://docs.capillarytech.com/docs/diy-templates-connectplus.md)
- [Member Care](https://docs.capillarytech.com/docs/member-care-new-ui.md): The member care page provides the complete details of a customer.
  - [Customer overview](https://docs.capillarytech.com/docs/customer_overview.md)
  - [Loyalty details](https://docs.capillarytech.com/docs/view-loyalty_details.md)
  - [Event details](https://docs.capillarytech.com/docs/view-event_details.md)
  - [Incentive details](https://docs.capillarytech.com/docs/view-incentive_details.md)
  - [Communication details](https://docs.capillarytech.com/docs/view-communication_details.md)
  - [Identifier change request](https://docs.capillarytech.com/docs/manage-id-change_requests.md): This page provides you with information on how to submit and approve identifier change requests via the Member Care page.
  - [Points & coupons request](https://docs.capillarytech.com/docs/issue-goodwill-points_coupons.md): Administrators of an org can manage goodwill requests and also issue points or coupons directly to customers.
  - [Retro transaction request](https://docs.capillarytech.com/docs/retro_transaction.md)
  - [Customise Member Care UI using Extension](https://docs.capillarytech.com/docs/vulcan-application-extension-in-member-care.md)
  - [Session Logs](https://docs.capillarytech.com/docs/session_logs.md)
  - [Group view](https://docs.capillarytech.com/docs/group_view.md): This section provides you with information on how to view details related to user groups.
  - [(New) Request Workflow](https://docs.capillarytech.com/docs/new-request-workflow.md)
    - [Introduction](https://docs.capillarytech.com/docs/new-request-flow-introduction.md)
    - [Configuring Request workflow for Customer Enrolment](https://docs.capillarytech.com/docs/configuring-issue-badges-request-workflow.md)
    - [Configuring Request Workflow for Badge Issuance](https://docs.capillarytech.com/docs/configuring-earn-badge-request-workflow.md)
    - [Configuring Request Workflow for Customer Status Change](https://docs.capillarytech.com/docs/configuring-customer-status-change-request-workflow.md)
    - [Configuring Points Redemption Request Workflow](https://docs.capillarytech.com/docs/configuring-points-redemption-request-workflow.md)
    - [Configuring Goodwill Points Request Workflow](https://docs.capillarytech.com/docs/configuring-goodwill-points-request-workflow.md)
    - [FAQ](https://docs.capillarytech.com/docs/new-request-workflow-faq.md)
  - [Advanced points breakup view](https://docs.capillarytech.com/docs/advanced-points-breakup_view.md)
- [Member Care (Old UI)](https://docs.capillarytech.com/docs/member-care.md): The Member Care page provides the complete details of a customer.
  - [Register customers](https://docs.capillarytech.com/docs/register-customers.md)
  - [Search customer/coupon](https://docs.capillarytech.com/docs/search-customercoupon.md)
  - [Issue & update cards](https://docs.capillarytech.com/docs/issue-update-cards.md)
  - [Manage ID change requests](https://docs.capillarytech.com/docs/manage-change-request.md): This page provides you with information on how to modify identifiers through the Member Care page.
  - [Issue goodwill points & coupons](https://docs.capillarytech.com/docs/issue-goodwill-points-coupons.md): Administrators of an org can manage goodwill requests and also issue points or coupons directly to customers.
  - [Retro transactions](https://docs.capillarytech.com/docs/tag-not-interested-transactions.md)
  - [Reallocate mobile numbers](https://docs.capillarytech.com/docs/reallocate-mobile-numbers.md)
  - [Manage customer feedback](https://docs.capillarytech.com/docs/manage-customer-feedback-1.md)
- [Data Import](https://docs.capillarytech.com/docs/data-import.md)
  - [Customer Import Profile](https://docs.capillarytech.com/docs/customer-import-profile-1.md)
  - [Transaction Entity Profile](https://docs.capillarytech.com/docs/transaction-profile.md)
    - [Regular Transaction Import Profile](https://docs.capillarytech.com/docs/regular-transaction-profile.md)
    - [Payment Mode Import Profile](https://docs.capillarytech.com/docs/payment-mode-profile.md)
    - [Not Interested Transaction Import Profile](https://docs.capillarytech.com/docs/not-interested-transaction-profile.md)
    - [Points Expiry Import Profile](https://docs.capillarytech.com/docs/points-expiry-profile.md)
    - [Points Redemption Import Profile](https://docs.capillarytech.com/docs/points-redemption-profile.md)
    - [Historical Points Import Profile](https://docs.capillarytech.com/docs/historical-points-profile.md)
    - [Promotion Points Import Profile](https://docs.capillarytech.com/docs/promotion-points-profile.md)
  - [Card Entity Profile](https://docs.capillarytech.com/docs/card-profile.md)
    - [Card Import Profile](https://docs.capillarytech.com/docs/card-import-profile.md)
  - [FAQs](https://docs.capillarytech.com/docs/data-import-faqs.md)
- [Data Import (Old UI)](https://docs.capillarytech.com/docs/data-import-.md)
  - [Transactions profiles](https://docs.capillarytech.com/docs/transactions-profiles.md)
  - [Customer profiles](https://docs.capillarytech.com/docs/customer-profiles.md)
  - [Inventory profiles](https://docs.capillarytech.com/docs/inventory-profiles.md)
  - [Org entities](https://docs.capillarytech.com/docs/org-entities.md)
  - [Points & Slabs](https://docs.capillarytech.com/docs/points-slabs.md)
  - [Points deductions](https://docs.capillarytech.com/docs/points-deductions.md)
  - [Points expiry](https://docs.capillarytech.com/docs/points-expiry.md)
  - [Other import profiles](https://docs.capillarytech.com/docs/other-import-profiles.md)
  - [Data cleanup](https://docs.capillarytech.com/docs/data-cleanup.md)
  - [Target loyalty](https://docs.capillarytech.com/docs/target-loyalty-1.md)
  - [Company](https://docs.capillarytech.com/docs/company.md)
  - [View import jobs](https://docs.capillarytech.com/docs/view-import-jobs-1.md)
  - [Fetch import details by import ID](https://docs.capillarytech.com/docs/fetching-import-details-by-import-id.md)
  - [Downloading reports (After temp DB import)](https://docs.capillarytech.com/docs/downloading-reports-after-temp-db-import.md)
  - [Mark stores as inactive using the data import](https://docs.capillarytech.com/docs/mark-stores-as-inactive-using-the-data-import.md)
- [Data export](https://docs.capillarytech.com/docs/export.md)
  - [Introduction to Export Templates UI](https://docs.capillarytech.com/docs/navigation-of-standard-and-custom-templates.md)
  - [Standard Templates](https://docs.capillarytech.com/docs/standard_templates.md)
    - [Return Transactions Standard Export Template](https://docs.capillarytech.com/docs/return-transactions-standard-export-template.md)
    - [Responsed Standard Export Template](https://docs.capillarytech.com/docs/response-info-standard-export-template.md)
    - [Contacted Standard Export Template](https://docs.capillarytech.com/docs/contacted-standard-export-template.md)
    - [Transactions Standard Export Template](https://docs.capillarytech.com/docs/transactions-standard-export-template.md)
    - [Payment Mode Standard Export Template](https://docs.capillarytech.com/docs/payment-mode-standard-export-template.md)
    - [Tracker Value Standard Export Template](https://docs.capillarytech.com/docs/tracker-value-standard-export-template.md)
    - [Customer Merge Event Log Standard Export Template](https://docs.capillarytech.com/docs/customer-merge-event-log-standard-export-template.md)
    - [Slab Change Log Standard Export Template](https://docs.capillarytech.com/docs/slab-change-log-standard-export-template.md)
    - [Issue Trackers Standard Export Template](https://docs.capillarytech.com/docs/issue-trackers-standard-export-template.md)
    - [Messages Standard Export Template](https://docs.capillarytech.com/docs/messages-standard-export-template.md)
    - [Call Tasks Standard Export Template](https://docs.capillarytech.com/docs/call-tasks-standard-export-template.md)
    - [Footfall Standard Export Template](https://docs.capillarytech.com/docs/footfall-standard-export-template.md)
    - [Profiles Standard Export Template](https://docs.capillarytech.com/docs/profiles-2-standard-export-template.md)
    - [Points Standard Export Templates](https://docs.capillarytech.com/docs/points-standard-export-template.md)
    - [Members Standard Export Template](https://docs.capillarytech.com/docs/members-standard-export-template.md)
    - [Coupons Standard Export Template](https://docs.capillarytech.com/docs/coupons-standard-export-template.md)
    - [Badges Standard Export Templates](https://docs.capillarytech.com/docs/badges-standard-export-template.md)
    - [Registration Event Standard Export Template](https://docs.capillarytech.com/docs/registration-event-standard-export-template.md)
    - [Goodwill Requests Standard Export Template](https://docs.capillarytech.com/docs/goodwill-requests-standard-export-template.md)
    - [Invitation Sent Standard Export Template](https://docs.capillarytech.com/docs/invitation-sent-standard-export-template.md)
  - [Custom Templates](https://docs.capillarytech.com/docs/custom-templates.md)
    - [Dimensions & attributes](https://docs.capillarytech.com/docs/dimensions-attributes.md)
  - [Schedule an Export Job & Fetch Details](https://docs.capillarytech.com/docs/schedule-an-export-job-fetch-details.md)
    - [Create an export job (Step 1 of 3)](https://docs.capillarytech.com/docs/create-an-export-job-step-1-of-3.md)
    - [Select Data Templates (Step 2 of 3)](https://docs.capillarytech.com/docs/select-data-templates-step-2-of-3.md)
    - [Modify Template & Creating Schedule (Step 3 of 3)](https://docs.capillarytech.com/docs/modifying-template-creating-schedule-step-3-of-3.md)
  - [Edit an Export Job](https://docs.capillarytech.com/docs/editing-an-export-job.md)
  - [Reuse an Export job (Duplicate)](https://docs.capillarytech.com/docs/reuse-an-export-job-duplicate.md)
  - [Export Audience Group](https://docs.capillarytech.com/docs/exporting-audience-group.md)
  - [Use Cases on Data Export](https://docs.capillarytech.com/docs/use-cases-on-data-export.md)
  - [External Facts](https://docs.capillarytech.com/docs/external_facts.md)
  - [Data export FAQs](https://docs.capillarytech.com/docs/data-export-faqs.md)
  - [Configure SFTP server for data export](https://docs.capillarytech.com/docs/configure-sftp-server-for-data-export.md)
  - [Historical Statements](https://docs.capillarytech.com/docs/historical-statements.md)
- [Event notification](https://docs.capillarytech.com/docs/configure_event_notification.md)
  - [Overview](https://docs.capillarytech.com/docs/overview-2.md)
  - [Supported Events](https://docs.capillarytech.com/docs/supported_events.md)
  - [Configure Event Notification](https://docs.capillarytech.com/docs/configure-event-notification.md)
  - [Manage Webhook](https://docs.capillarytech.com/docs/manage-webhook.md)
  - [View Event Feed](https://docs.capillarytech.com/docs/view-event-feed.md)
  - [Event Delivery and Reliability](https://docs.capillarytech.com/docs/copy-of-consuming-event-notifications.md)
  - [Event schema (Payload)](https://docs.capillarytech.com/docs/event-schema-payload.md)
    - [Customer and User Group](https://docs.capillarytech.com/docs/event-schema-customer.md)
    - [Transaction](https://docs.capillarytech.com/docs/event-schema-rewards.md)
    - [Loyalty](https://docs.capillarytech.com/docs/event-schema-loyalty.md)
    - [Loyalty Promotions and Cart Promotions](https://docs.capillarytech.com/docs/event-schema-loyalty-and-cart-promotions.md)
    - [Tier](https://docs.capillarytech.com/docs/event-schema-tier.md)
    - [Partner Program](https://docs.capillarytech.com/docs/event-schema-partner-program.md)
    - [Incentives](https://docs.capillarytech.com/docs/event-schema-incentives.md)
    - [Cards](https://docs.capillarytech.com/docs/event-schema-cards.md)
    - [Request Updates](https://docs.capillarytech.com/docs/event-schema-request-updated.md)
    - [Advanced Request Workflows](https://docs.capillarytech.com/docs/event-schema-advanced-request-workflows.md)
    - [Labels](https://docs.capillarytech.com/docs/event-schema-labels.md)
- [Timezone Management](https://docs.capillarytech.com/docs/timezone-management.md)
  - [Understanding Timezone Management in the UI](https://docs.capillarytech.com/docs/understanding-timezone-management-in-the-ui.md)
  - [FAQs](https://docs.capillarytech.com/docs/faqs-timezoneui.md)

## User Documentation: LOYALTY+
- [Introduction to Loyalty+](https://docs.capillarytech.com/docs/loyalty-overview.md)
  - [Overview](https://docs.capillarytech.com/docs/overview.md)
  - [Types of Loyalty Programs](https://docs.capillarytech.com/docs/types-of-loyalty-programs-we-support.md)
    - [Single Loyalty Program](https://docs.capillarytech.com/docs/single-loyalty-program.md)
    - [Multi Loyalty Programs](https://docs.capillarytech.com/docs/create-a-multi-loyalty-program.md)
    - [Coalition program](https://docs.capillarytech.com/docs/coalition-program.md): This section provides you with information about coalition programs and how to set up a coalition program.
    - [Subscription program](https://docs.capillarytech.com/docs/subscription-program.md): This section provides you with information about subscription program and how to set up a subscription program.
    - [User Group Loyalty](https://docs.capillarytech.com/docs/user-group-loyalty.md)
      - [Introduction](https://docs.capillarytech.com/docs/introduction-to-user-groups.md)
      - [Prerequisites](https://docs.capillarytech.com/docs/user-group-prerequisites.md): Configuration flags and prerequisites required to enable User Group Loyalty.
      - [Create and Manage Groups](https://docs.capillarytech.com/docs/creating-and-managing-groups.md): Create friends and family groups, business groups, manage members, and delete groups.
      - [Configure Group Programs](https://docs.capillarytech.com/docs/configuring-group-programs.md): Enrol groups in loyalty programs, set up promotions, and configure group trackers.
      - [Configure Points Contribution and Deduction](https://docs.capillarytech.com/docs/configuring-user-group-points.md): Configure earning, allocation, expiry, and redemption rules for a group wallet.
      - [Configure Group Tier Synchronisation](https://docs.capillarytech.com/docs/tier-synchronization.md)
      - [Use Cases](https://docs.capillarytech.com/docs/user-group-use-cases.md)
      - [Limitations](https://docs.capillarytech.com/docs/user-group-limitations.md)
      - [Reports for User Groups](https://docs.capillarytech.com/docs/monitoring-and-reporting.md): Export group loyalty data and identify group activity in Insights+.
      - [Frequenty Asked Questions](https://docs.capillarytech.com/docs/user-group-faqs.md): Common questions and tips for User Group Loyalty.
  - [Tier](https://docs.capillarytech.com/docs/tier.md)
  - [Subscription](https://docs.capillarytech.com/docs/subscription.md)
  - [Benefits](https://docs.capillarytech.com/docs/benefits-1.md)
  - [Streaks](https://docs.capillarytech.com/docs/streaks-1.md)
  - [Milestones](https://docs.capillarytech.com/docs/milestones.md)
  - [Games](https://docs.capillarytech.com/docs/games-1.md)
  - [Reward Currency](https://docs.capillarytech.com/docs/reward-currency.md)
    - [Points](https://docs.capillarytech.com/docs/points.md)
      - [Points Rolling Expiry](https://docs.capillarytech.com/docs/points-rolling-expiry.md)
      - [Points Strategy](https://docs.capillarytech.com/docs/points-strategy.md)
    - [Alternate Currencies](https://docs.capillarytech.com/docs/alternate-currencies.md): This page information of alternate currencies, aka a new set of currencies similar to points for implementing various market use cases like starts, stamps, tier points, etc..
  - [Accessing loyalty: RBAC (Role-based access control)](https://docs.capillarytech.com/docs/rbac-role-based-access-control.md): View Mode: Configurable Access Control
  - [FAQs](https://docs.capillarytech.com/docs/loyalty-faqs.md)
- [Launching Your Loyalty Program](https://docs.capillarytech.com/docs/launching-your-loyalty-program.md)
  - [Create a Loyalty Program](https://docs.capillarytech.com/docs/create-a-loyalty-program.md)
  - [Manage a Loyalty Program](https://docs.capillarytech.com/docs/manage-loyalty-program.md)
    - [Create and Manage Tiers](https://docs.capillarytech.com/docs/tiers.md): Configure and manage loyalty tiers using the redesigned Tiers experience, including the tabular comparison view, guided creation flow, and maker-checker approval.
      - [Create Tiers and Configure Tier Upgrade Conditions](https://docs.capillarytech.com/docs/create-tiers-and-configure-tier-upgrade-conditions.md)
      - [Configure Validity and Renewal Conditions](https://docs.capillarytech.com/docs/configure-renewal-conditions.md)
      - [Configure Tier Downgrade](https://docs.capillarytech.com/docs/configure-tier-downgrade.md)
      - [Configure Communication for Tier Upgrade, Renewal and Points Expiry](https://docs.capillarytech.com/docs/communication.md)
    - [Create and Manage Subscriptions](https://docs.capillarytech.com/docs/subscriptions.md): Create and manage subscription programs, paid or free membership add-ons layered on top of your loyalty program, using the redesigned Subscriptions experience.
    - [Create and Manage Benefits](https://docs.capillarytech.com/docs/benefits.md): Create standalone loyalty benefits, group them into categories, and attach them to tiers and subscriptions.
  - [Create Loyalty Program Reports](https://docs.capillarytech.com/docs/point-conditions.md)
    - [Loyalty Standard Report](https://docs.capillarytech.com/docs/loyalty-standard-report.md)
    - [Loyalty Sales Report](https://docs.capillarytech.com/docs/standard-loyalty-reports.md)
    - [Loyalty Customer Summary Report](https://docs.capillarytech.com/docs/loyalty-customer-summary-report.md)
    - [Points Report](https://docs.capillarytech.com/docs/points-2.md)
    - [Points Report (new)](https://docs.capillarytech.com/docs/points-report-new.md)
    - [Non Member Report](https://docs.capillarytech.com/docs/loyalty-sales-report.md)
    - [Points Redemption Custom Fields](https://docs.capillarytech.com/docs/redemption-custom-field.md): QUERIES FOR POINTS REDEMPTION CUSTOM FIELD
  - [Configure Loyalty Settings](https://docs.capillarytech.com/docs/loyalty-configuration-settings.md)
  - [Configure Advanced Settings](https://docs.capillarytech.com/docs/configure-advanced-settings.md): Configure the program-wide settings that apply across Benefits, Tiers, and Subscriptions: Benefit categories, Loyalty Config Attributes, and Ranking & Stacking.
  - [Use cases](https://docs.capillarytech.com/docs/use-cases_loyalty.md)
- [Loyalty Promotions](https://docs.capillarytech.com/docs/loyalty-promotions.md)
  - [Introduction](https://docs.capillarytech.com/docs/loyalty-promotions-introduction.md)
  - [Core Concepts](https://docs.capillarytech.com/docs/loyalty-promotions-core-concepts.md)
  - [Building Blocks of Loyalty Promotions](https://docs.capillarytech.com/docs/building-blocks-of-loyalty-promotions.md)
    - [Member Actions](https://docs.capillarytech.com/docs/loyalty-promotions-member-actions.md)
    - [Qualifying Conditions and Attributes](https://docs.capillarytech.com/docs/loyalty-promotions-qualifying-conditions.md)
    - [Operators](https://docs.capillarytech.com/docs/loyalty-promotions-operators.md)
    - [Brand Actions](https://docs.capillarytech.com/docs/loyalty-promotions-actions.md)
    - [Loyalty Promotion Limits](https://docs.capillarytech.com/docs/loyalty-promotions-limits.md)
  - [Create and Manage Loyalty Promotions](https://docs.capillarytech.com/docs/loyalty-promotions-creating-and-managing-loyalty-promotions.md)
    - [Create a Loyalty Promotion](https://docs.capillarytech.com/docs/loyalty-promotions-creating-a-loyalty-promotion.md)
    - [Create a Broadcast Promotion](https://docs.capillarytech.com/docs/create-a-broadcast-promotion.md)
    - [Approve or Reject a Loyalty Promotion](https://docs.capillarytech.com/docs/loyalty-promotions-approving-or-rejecting-a-loyalty-promotion.md)
    - [View a Loyalty Promotion](https://docs.capillarytech.com/docs/loyalty-promotions-viewing-a-loyalty-promotion.md)
    - [Duplicate a Loyalty Promotion](https://docs.capillarytech.com/docs/loyalty-promotions-duplicating-a-loyalty-promotion.md)
    - [Edit a Loyalty Promotion](https://docs.capillarytech.com/docs/loyalty-promotions-editing-a-loyalty-promotion.md)
    - [Pause and End a Loyalty Promotion](https://docs.capillarytech.com/docs/loyalty-promotions-pausing-and-ending-a-loyalty-promotion.md)
  - [Configure Reports and Event Notifications](https://docs.capillarytech.com/docs/reporting-and-event-notifications.md)
    - [Configure a Loyalty Promotion Report](https://docs.capillarytech.com/docs/loyalty-promotions-reporting.md)
    - [Configure a Loyalty Promotion Event Notification](https://docs.capillarytech.com/docs/loyalty-promotions-event-notifications.md)
  - [Use Cases](https://docs.capillarytech.com/docs/loyalty-promotions-use-cases.md)
  - [FAQs](https://docs.capillarytech.com/docs/loyalty-promotions-faqs.md)
- [Programs Home Page](https://docs.capillarytech.com/docs/dashboard.md)
- [Trackers](https://docs.capillarytech.com/docs/trackers.md)
- [Workflows](https://docs.capillarytech.com/docs/workflows.md)
  - [Customer Activities](https://docs.capillarytech.com/docs/activities.md)
  - [Auto points conversion to reward](https://docs.capillarytech.com/docs/auto-points-conversion-to-reward.md): New Customer Activity : Auto points conversion to reward
  - [Actions](https://docs.capillarytech.com/docs/actions.md)
  - [Rule Writing](https://docs.capillarytech.com/docs/rule-writing.md)
  - [Advanced Capping](https://docs.capillarytech.com/docs/advanced-capping.md)
- [Profiles and Attributes](https://docs.capillarytech.com/docs/profiles.md): This page provides the list of attributes supported for each profile.
  - [Profile : Current Customer](https://docs.capillarytech.com/docs/avgbasket-size.md)
    - [Attributes - Customer Identity](https://docs.capillarytech.com/docs/attributes-namefirst-namelast-name.md)
    - [Attributes - KPIs (Customer Points)](https://docs.capillarytech.com/docs/attributes-current-customer-points.md)
    - [Attributes - Custom Field](https://docs.capillarytech.com/docs/attributes-custom-field.md)
    - [Attributes - Slab Information](https://docs.capillarytech.com/docs/attribute-slab-information.md)
    - [Attributes - User Segment (EI)](https://docs.capillarytech.com/docs/user-segment-ei-attributes.md)
    - [Attributes - KPIs (Transaction Data)](https://docs.capillarytech.com/docs/attributes-kpis.md): Attributes covered: avgBasketSize , avgSpendPerVisit, clusterValueIncludes, clusterValueExcludes, numberOfTxns, numberOfTxns, numberOfVisits
    - [Attributes - Registration Date](https://docs.capillarytech.com/docs/attribute-joindate.md)
    - [Attributes - Other](https://docs.capillarytech.com/docs/attribute-loyalty-information-1.md)
    - [Attributes - Customer status & label](https://docs.capillarytech.com/docs/attribute-customer-status-label.md)
    - [Customer Subscription Status](https://docs.capillarytech.com/docs/customer-subscription-status.md)
  - [Profile : Current Transaction](https://docs.capillarytech.com/docs/profile-current-transactioncurrenttxn.md): Attributes based on Transaction
    - [Attributes - KPI (Basket)](https://docs.capillarytech.com/docs/a.md)
    - [Attributes - Transaction Number/ID](https://docs.capillarytech.com/docs/attributes-based-on-customer-identity.md)
    - [Attributes - Custom Fields (Transaction)](https://docs.capillarytech.com/docs/attributes-custom-fields.md)
    - [Attribute - Transaction Value](https://docs.capillarytech.com/docs/attribute-transaction-value.md)
    - [Attribute - Reward Currency](https://docs.capillarytech.com/docs/attribute-transaction-points.md)
    - [Attribute - Discount](https://docs.capillarytech.com/docs/attribute-discount.md)
    - [Attribute - Date](https://docs.capillarytech.com/docs/attribute-date-transactionpurchase-date.md): Transaction/Purchase date.
    - [Attribute - Note](https://docs.capillarytech.com/docs/attribute-using-standard-field.md)
  - [Profile : Current Line Item](https://docs.capillarytech.com/docs/profile-current-line-item.md)
    - [Attribute - Line Item Information](https://docs.capillarytech.com/docs/attribute-line-item-information.md)
    - [Attributes - discount & discPercentage](https://docs.capillarytech.com/docs/attribute-discount-1.md)
    - [Attributes - Line Item Properties](https://docs.capillarytech.com/docs/attributes-line-item-properties.md)
  - [Profile : Current Event](https://docs.capillarytech.com/docs/current-event.md)
    - [Attribute - Target Based](https://docs.capillarytech.com/docs/attribute-target-based.md)
    - [Attribute - Loyalty Information](https://docs.capillarytech.com/docs/attribute-loyalty-information.md)
    - [Attributes - Custom Field](https://docs.capillarytech.com/docs/attributes-custom-field-1.md)
  - [Profile : Current Store](https://docs.capillarytech.com/docs/profile-current-store.md)
    - [Attribute : Code](https://docs.capillarytech.com/docs/attribute-code.md)
  - [Profile : Current Tracker](https://docs.capillarytech.com/docs/profile-currenttracker.md)
    - [Attributes - Tracker](https://docs.capillarytech.com/docs/attributes-tracker.md)
  - [Profile: Current Card](https://docs.capillarytech.com/docs/profile-current-card.md)
    - [Attributes - Custom and Extended Fields](https://docs.capillarytech.com/docs/attributes-custom-and-extended-fields.md)
  - [Profile: Current User Group](https://docs.capillarytech.com/docs/profile-current-user-group.md)
    - [Attributes - Group Identity](https://docs.capillarytech.com/docs/attributes-group-identity.md)
    - [Attributes - Group Membership](https://docs.capillarytech.com/docs/group-membership-attributes.md)
    - [Attributes - KPIs (User Group Points)](https://docs.capillarytech.com/docs/kpi-based-on-points.md)
    - [Attributes - KPI (User Group Slab/Tier)](https://docs.capillarytech.com/docs/attributes-kpi-user-group-slabtier.md)
- [Milestones (also known as Target loyalty)](https://docs.capillarytech.com/docs/milestones-new-flow.md): This page provides you with information on Milestones, including details on what they are, how to configure them, where to configure them, and how to connect a loyalty promotion to a milestone.
  - [Unified target/milestones](https://docs.capillarytech.com/docs/unified-milestones.md): This document provides you with information on Unified milestones.
- [Streaks](https://docs.capillarytech.com/docs/streaks.md): This page provides you with information on streaks, a powerful gamification capability that creates a user base that performs the desired activity continoulsy as configured by the brand.
  - [Overview](https://docs.capillarytech.com/docs/overview-streaks.md)
  - [Configure Streaks](https://docs.capillarytech.com/docs/configure-streaks.md)
  - [Connect the streak to loyalty promotions](https://docs.capillarytech.com/docs/connect-the-streak-to-loyalty-promotions.md)
  - [FAQ](https://docs.capillarytech.com/docs/faq.md)
- [Advanced Settings](https://docs.capillarytech.com/docs/loyalty-org-settingsdf.md)
- [Overview](https://docs.capillarytech.com/docs/games_overview.md): This page provides you with an overview about Games feature.
- [Configure Games](https://docs.capillarytech.com/docs/configure-games.md)
  - [Marvel Games](https://docs.capillarytech.com/docs/marvel-games.md): This page provides you with information on configuring games on marvel.

## User Documentation: ENGAGE+
- [Introduction to Engage+](https://docs.capillarytech.com/docs/introduction-to-engage.md)
  - [Engage+ Overview](https://docs.capillarytech.com/docs/engage-overview.md)
  - [Accessing Engage](https://docs.capillarytech.com/docs/accessing-engage.md)
  - [Engage+ Core Concepts](https://docs.capillarytech.com/docs/engage-core-concepts.md)
    - [Anonymous users](https://docs.capillarytech.com/docs/anonymous-users.md): Learn how to set up anonymous-user support and engage website and app visitors in Engage+ before they sign in or register.
- [Campaign Management](https://docs.capillarytech.com/docs/campaign-management.md)
  - [Introduction](https://docs.capillarytech.com/docs/introduction-campaign.md)
  - [Create Campaign](https://docs.capillarytech.com/docs/create-campaign.md)
    - [Referral Campaign](https://docs.capillarytech.com/docs/referral-campaign.md)
    - [Survey Campaign](https://docs.capillarytech.com/docs/survey-campaign.md)
    - [Bounceback or DVS Campaign](https://docs.capillarytech.com/docs/bounceback-or-dvs-campaign.md)
    - [Broadcast Campaign](https://docs.capillarytech.com/docs/broadcast-campaign.md)
    - [Ads Audience Campaign](https://docs.capillarytech.com/docs/ads-audience-campaign.md)
    - [Journey Campaign](https://docs.capillarytech.com/docs/journey-campaign.md)
    - [Recurring Campaign](https://docs.capillarytech.com/docs/recurring-campaign.md)
  - [Manage Campaign](https://docs.capillarytech.com/docs/manage-campaign.md)
    - [Configure Test and Control Ratio for Campaign](https://docs.capillarytech.com/docs/create-test-and-control-ratio-for-campaign.md)
    - [Edit Live Campaign](https://docs.capillarytech.com/docs/edit-live-campaign.md)
    - [Search/Filter Campaign](https://docs.capillarytech.com/docs/searchfilter-campaign.md)
    - [Test Campaign](https://docs.capillarytech.com/docs/test-campaign.md)
    - [View Campaign Reports](https://docs.capillarytech.com/docs/view-campaign-reports.md)
    - [Configure Campaign Settings](https://docs.capillarytech.com/docs/configure-campaign-level-settings.md)
    - [Archive Campaigns](https://docs.capillarytech.com/docs/archive-campaign.md)
  - [Manage Campaign Message](https://docs.capillarytech.com/docs/manage-campaign-message.md)
    - [Create Message](https://docs.capillarytech.com/docs/create-message.md)
    - [Approve Message](https://docs.capillarytech.com/docs/approve-message.md)
    - [Schedule Message](https://docs.capillarytech.com/docs/schedule-message.md)
    - [Reject Message](https://docs.capillarytech.com/docs/reject-message.md)
    - [Stop Message](https://docs.capillarytech.com/docs/stop-message.md)
    - [View Message Details](https://docs.capillarytech.com/docs/view-message-details.md)
  - [Anonymous User Support  in Campaigns](https://docs.capillarytech.com/docs/anonymous-user-campaigns.md): Learn how to build campaigns that target anonymous (visitor) site or app users who haven't logged
- [Journey Management](https://docs.capillarytech.com/docs/journey-management.md): Journeys is an engagement automation interface that enables you to create scenario-based flows to nurture your customers throughout their lifecycle.
  - [Overview](https://docs.capillarytech.com/docs/overview-journey.md)
  - [Create Journey](https://docs.capillarytech.com/docs/create-journey.md)
    - [Configure Journey](https://docs.capillarytech.com/docs/configure-journey.md): This section provides you with information on how to configure a journey.
    - [Configure Events and Conditions](https://docs.capillarytech.com/docs/configure-events-and-conditions.md)
    - [Upload Store Data in User Event](https://docs.capillarytech.com/docs/store-csv-upload.md)
  - [Building Blocks of a Journey](https://docs.capillarytech.com/docs/building-blocks-of-a-journey.md): Building blocks in a journey are the components used to create the journey. After the entry trigger, the building blocks define the journey of a customer.  Each building block has a  specific purpose…
    - [Overview](https://docs.capillarytech.com/docs/overview-building-blocks-of-a-journey.md)
    - [Engagement Building Block](https://docs.capillarytech.com/docs/engagement-building-block.md)
    - [Flow Control Building Block](https://docs.capillarytech.com/docs/flow-control-building-block.md)
    - [Action Building Block](https://docs.capillarytech.com/docs/action-building-block.md)
  - [Anonymous User Support in Journeys](https://docs.capillarytech.com/docs/anonymous-user-support-in-journeys.md): Learn how to build Journeys that target anonymous (visitor) site or app users who haven't logged in or registered.
  - [Manage Journey](https://docs.capillarytech.com/docs/manage-journey.md)
    - [Manage Live Journey Version](https://docs.capillarytech.com/docs/manage-live-journey-versions.md)
    - [Duplicate Journey](https://docs.capillarytech.com/docs/duplicate-journey.md)
    - [Test Journey](https://docs.capillarytech.com/docs/test-journey.md)
    - [Archive journeys](https://docs.capillarytech.com/docs/archive-journey.md)
    - [Block-Level Reporting in Journey](https://docs.capillarytech.com/docs/block-level-reporting-in-journey.md)
    - [Search User Journey History](https://docs.capillarytech.com/docs/search-user-journey-history.md)
  - [FAQs](https://docs.capillarytech.com/docs/faqs-journey.md)
- [FAQs](https://docs.capillarytech.com/docs/campaign_faqs.md)

## User Documentation: CHANNELS
- [Introduction](https://docs.capillarytech.com/docs/introduction-engagement-channels.md)
- [Supported Engagement Channels](https://docs.capillarytech.com/docs/engagement-channels.md)
  - [SMS](https://docs.capillarytech.com/docs/sms.md)
    - [Configure SMS Settings](https://docs.capillarytech.com/docs/configure-sms-settings.md)
    - [Configure SMS Template & Content](https://docs.capillarytech.com/docs/configure-sms-template-content.md)
    - [Configure Link Tracking in SMS](https://docs.capillarytech.com/docs/track-links-in-sms.md)
    - [Use Case](https://docs.capillarytech.com/docs/use-case-sms.md)
  - [Email](https://docs.capillarytech.com/docs/email.md)
    - [Configure Email Settings](https://docs.capillarytech.com/docs/configure-email-settings.md)
    - [Configure Email](https://docs.capillarytech.com/docs/configure-email.md)
    - [Use Case](https://docs.capillarytech.com/docs/use-case-email.md)
    - [FAQs](https://docs.capillarytech.com/docs/faqs-email.md)
  - [Call Task](https://docs.capillarytech.com/docs/call-task.md)
    - [Configure Call Task Settings](https://docs.capillarytech.com/docs/configure-call-task.md)
    - [Create Call Task Template](https://docs.capillarytech.com/docs/create-call-task-template-.md)
    - [Configure Call Task Content](https://docs.capillarytech.com/docs/configure-call-task-content.md)
    - [Use Case](https://docs.capillarytech.com/docs/use-case-call-task.md)
  - [WhatsApp](https://docs.capillarytech.com/docs/whatsapp.md)
    - [Configure WhatsApp Settings](https://docs.capillarytech.com/docs/configure-whatsapp-settings.md)
    - [Create WhatsApp Template](https://docs.capillarytech.com/docs/create-whatsapp-template.md)
    - [Configure WhatsApp Content](https://docs.capillarytech.com/docs/configure-whatsapp-content.md)
    - [Manage WhatsApp Subscription](https://docs.capillarytech.com/docs/whatsapp-subscription-management.md)
    - [Use Case](https://docs.capillarytech.com/docs/use-case-whatsapp.md)
  - [Wechat](https://docs.capillarytech.com/docs/wechat.md)
    - [Create Wechat Template](https://docs.capillarytech.com/docs/create-wechat-template-.md)
    - [Configure Wechat Content](https://docs.capillarytech.com/docs/configure-wechat-content.md)
  - [Viber](https://docs.capillarytech.com/docs/viber.md)
    - [Configure Viber Settings](https://docs.capillarytech.com/docs/configure-viber-settings.md)
    - [Create Viber Template](https://docs.capillarytech.com/docs/create-viber-template-.md)
    - [Configure Viber Content](https://docs.capillarytech.com/docs/configure-viber-content.md)
  - [Push Notification](https://docs.capillarytech.com/docs/push-notifications.md)
    - [Configure Push Notification Settings](https://docs.capillarytech.com/docs/getting-started-with-push.md)
    - [Create Push Notification Template](https://docs.capillarytech.com/docs/create-push-notification-template.md)
    - [Configure Push Notification Content](https://docs.capillarytech.com/docs/configure-push-notification-content.md)
    - [Creating and Sending Push Notifications](https://docs.capillarytech.com/docs/creating-and-sending-push-notifications.md)
    - [Reporting](https://docs.capillarytech.com/docs/reporting.md)
    - [Optimizing Delivery](https://docs.capillarytech.com/docs/optimizing-delivery.md)
    - [Push Notification Regulations](https://docs.capillarytech.com/docs/push-notification-regulations.md)
    - [Frequently Asked Questions](https://docs.capillarytech.com/docs/frequently-asked-questions.md)
    - [Use Case](https://docs.capillarytech.com/docs/use-case.md)
  - [RCS](https://docs.capillarytech.com/docs/rcs.md)
    - [Configure RCS Settings](https://docs.capillarytech.com/docs/configure-rcs-settings.md)
    - [Create RCS Template](https://docs.capillarytech.com/docs/create-rcs-template-.md)
    - [Configure RCS Content](https://docs.capillarytech.com/docs/configure-rcs-content.md)
  - [Zalo](https://docs.capillarytech.com/docs/zalo.md)
    - [Configure Zalo Settings](https://docs.capillarytech.com/docs/configure-zalo-settings.md)
    - [Create Zalo Template](https://docs.capillarytech.com/docs/create-zalo-template-.md)
    - [Configure Zalo Templates for Campaigns and Journeys](https://docs.capillarytech.com/docs/configure-zalo-templates-for-campaigns-and-journeys.md)
  - [In-app Message](https://docs.capillarytech.com/docs/in-app-message-.md)
    - [Configure In-app Settings](https://docs.capillarytech.com/docs/configuring-in-app-message.md)
    - [Create In app Template](https://docs.capillarytech.com/docs/create-in-app-template.md)
    - [Configure In app Message Content](https://docs.capillarytech.com/docs/configure-in-app-message-content.md)
    - [Send In-app Message on Campaign](https://docs.capillarytech.com/docs/send-in-app-message-on-campaign.md)
    - [Reporting](https://docs.capillarytech.com/docs/reporting-inapp-message.md)
    - [Use Case](https://docs.capillarytech.com/docs/use-case-inapp-message.md)
  - [LINE](https://docs.capillarytech.com/docs/line.md)
    - [Configure LINE Settings](https://docs.capillarytech.com/docs/configure-line-settings.md)
    - [Create LINE Template](https://docs.capillarytech.com/docs/create-line-template-.md)
    - [Configure LINE Content](https://docs.capillarytech.com/docs/configure-line-content.md)
    - [Send LINE Message on Campaign](https://docs.capillarytech.com/docs/sending-line-message-on-campaign.md)
    - [Frequently Asked Questions](https://docs.capillarytech.com/docs/frequently-asked-questions-1.md)
  - [Configure Delivery Settings](https://docs.capillarytech.com/docs/configure-communication-channel-settings.md)
  - [Configure Channel Priority](https://docs.capillarytech.com/docs/channel-priority.md)
  - [Configure Templates for Engagement Channels](https://docs.capillarytech.com/docs/configure-templates-for-engagement-channels.md)
  - [Test and Preview across engagement channels](https://docs.capillarytech.com/docs/test-and-preview-across-engagement-channels.md)
  - [FAQs](https://docs.capillarytech.com/docs/faqs-engagement-channels.md)
- [Personalisation](https://docs.capillarytech.com/docs/personalisation.md)
  - [Labels](https://docs.capillarytech.com/docs/labels.md)
    - [Supported Labels across Engage+](https://docs.capillarytech.com/docs/supported-labels-for-engagement-channels.md)
  - [Custom Tags](https://docs.capillarytech.com/docs/custom-tags.md)
  - [Add Dynamic Content Using Liquid](https://docs.capillarytech.com/docs/add-dynamic-content-using-liquid.md): This guide provides an overview of the Liquid template language, focusing on features relevant for personalizing messages in Engage+.
  - [Add Dynamic Content Using Custom Fields](https://docs.capillarytech.com/docs/add-dynamic-content-using-custom-fields.md)

## User Documentation: AUDIENCES
- [Audience Management](https://docs.capillarytech.com/docs/audience-management.md)
  - [Overview](https://docs.capillarytech.com/docs/overview-audience.md)
  - [About Audience Group Filters](https://docs.capillarytech.com/docs/about-audience-group-filters.md)
    - [Loyalty Based Filters](https://docs.capillarytech.com/docs/loyalty-information-based-filter.md)
    - [Transaction Based Filters](https://docs.capillarytech.com/docs/transaction-based-filters.md)
    - [Campaigns & Coupons Based Filters](https://docs.capillarytech.com/docs/campaigns-coupons-based-filters.md)
    - [User Profile Based Filters](https://docs.capillarytech.com/docs/user-profile-based-filters.md)
    - [Lead Based Filters](https://docs.capillarytech.com/docs/lead-based-filters.md)
    - [Cart & Catalog Promotion Filters](https://docs.capillarytech.com/docs/cart-catalog-promotion-filters.md)
    - [Behavioral Event Based Filters](https://docs.capillarytech.com/docs/behavioral-event-based-filters.md)
    - [Realtime Audience Filters](https://docs.capillarytech.com/docs/realtime-audience-filters.md): Build audience groups from live customer behavior, including behavioral events and session activity, instead of waiting for the next daily sync.
    - [AI Powered Filters](https://docs.capillarytech.com/docs/ai-powered-filters.md)
    - [Purchase Pattern/Behavior Based Filters](https://docs.capillarytech.com/docs/purchase-patternbehavior-based-filters.md)
    - [Common Filter Options (in filters)](https://docs.capillarytech.com/docs/common-filter-optionsin-filters.md)
  - [Create Audience Group](https://docs.capillarytech.com/docs/create-audience-group.md): Learn the different ways to create audience groups, including filters, CSV upload, combining existing groups, and FTP import.
  - [Add External ID for Audience Groups](https://docs.capillarytech.com/docs/add-external-id-for-audience-groups.md): Assign a unique external identifier to an audience group so that external systems can identify and map the group during integrations.
  - [Split Audience Group](https://docs.capillarytech.com/docs/split-an-audience-group.md)
  - [Understand Audience Reachability Status](https://docs.capillarytech.com/docs/understand-audience-reachability-status.md)
  - [FAQs](https://docs.capillarytech.com/docs/faqs-audience-management.md)

## User Documentation: REWARDS
- [Offers (coupons)](https://docs.capillarytech.com/docs/offers-coupons.md)
  - [Introduction to Offers](https://docs.capillarytech.com/docs/introduction-to-offers.md)
  - [Getting Started](https://docs.capillarytech.com/docs/create-offer-1.md)
  - [Coupon Management](https://docs.capillarytech.com/docs/manage-coupons.md)
  - [Using Offers in Campaigns](https://docs.capillarytech.com/docs/using-offers-in-campaigns.md)
  - [Event Notifications](https://docs.capillarytech.com/docs/offer-event-notifications.md)
  - [Reporting](https://docs.capillarytech.com/docs/offer-reporting.md)
  - [FAQ](https://docs.capillarytech.com/docs/faq-1.md)
- [Badges](https://docs.capillarytech.com/docs/customer_badges.md)
  - [Introduction to Badges](https://docs.capillarytech.com/docs/introduction-to-badges.md)
  - [Type of Badges](https://docs.capillarytech.com/docs/type-of-badges.md)
  - [Getting Started](https://docs.capillarytech.com/docs/getting-started-badges.md)
    - [Enabling & Creating a Badge](https://docs.capillarytech.com/docs/enabling-creating-a-badge.md)
    - [Viewing Badges](https://docs.capillarytech.com/docs/viewing-badges.md)
    - [Glossary of Terms](https://docs.capillarytech.com/docs/glossary-of-terms.md)
  - [Configuration for Badges](https://docs.capillarytech.com/docs/configuration-for-badges.md)
    - [Custom Field Information for Badges](https://docs.capillarytech.com/docs/custom-field-information-for-badges.md)
    - [Grouping and Ranking of Badges](https://docs.capillarytech.com/docs/grouping-and-ranking-of-badges.md)
  - [Managing Badges](https://docs.capillarytech.com/docs/managing-badges.md)
    - [Deactivating and Activating Badges](https://docs.capillarytech.com/docs/activating-and-deactivating-badges.md)
    - [Issuing Badges and Revoking via Loyalty Workflows and Promotions](https://docs.capillarytech.com/docs/issuing-badges-and-revoking-via-loyalty-workflows-and-promotions.md)
    - [Enrolling and Issuing Badges from Campaigns](https://docs.capillarytech.com/docs/enrolling-and-issuing-badges-from-campaigns.md)
    - [Enrolling and Issuing Badges from Journeys](https://docs.capillarytech.com/docs/enrolling-and-issuing-badges-from-journeys.md)
    - [Historical Data Migration of Badges](https://docs.capillarytech.com/docs/historical-data-migration-of-badges.md)
    - [Retro Enrolment and Issue of Badges](https://docs.capillarytech.com/docs/retro-enrolment-and-issue-of-badges.md)
  - [Badges Event Notification](https://docs.capillarytech.com/docs/badges-event-notification.md)
  - [Badges Reporting](https://docs.capillarytech.com/docs/badges-reporting.md)
  - [Badges in Campaigns](https://docs.capillarytech.com/docs/badges-in-campaigns.md)
  - [Badges in Membercare](https://docs.capillarytech.com/docs/badges-in-membercare.md)
- [Rewards Catalog](https://docs.capillarytech.com/docs/incentives-rewards-catalog.md)
  - [Introduction](https://docs.capillarytech.com/docs/introduction-rewards-catalog.md)
  - [Reward Types](https://docs.capillarytech.com/docs/reward-types.md)
  - [Create a Reward](https://docs.capillarytech.com/docs/create-a-reward.md)
  - [Manage rewards](https://docs.capillarytech.com/docs/manage-rewards.md)
  - [Rewards Catalog settings](https://docs.capillarytech.com/docs/rewards-catalog-settings.md)
  - [Rewards catalog - use cases](https://docs.capillarytech.com/docs/rewards-catalog-use-cases.md)
  - [Rewards Catalog FAQ](https://docs.capillarytech.com/docs/rewards-catalog-faq.md)
- [Rewards Catalog (Old marvel rewards)](https://docs.capillarytech.com/docs/rewards-catalog.md)
  - [Getting Started with Rewards Catalog](https://docs.capillarytech.com/docs/getting-started-with-rewards-catalog.md)
  - [Sample Rewards Catalog for Various Verticals](https://docs.capillarytech.com/docs/sample-rewards-catalog-for-various-verticals.md)
  - [Optimizing Your Rewards Budget & Catalog Inventory](https://docs.capillarytech.com/docs/optimizing-your-rewards-budget-catalog-inventory.md)
  - [Enhancing Rewards Catalog with Custom Fields](https://docs.capillarytech.com/docs/enhancing-rewards-catalog-with-custom-fields.md)
  - [Running Attractive Discounts on Rewards Catalog](https://docs.capillarytech.com/docs/running-attractive-discounts-on-rewards-catalog.md)
  - [Point Redemption for Unified Multiple Loyalty Programs](https://docs.capillarytech.com/docs/point-redemption-for-unified-multiple-loyalty-programs.md)
  - [Viewing Rewards Catalog Events in MemberCare](https://docs.capillarytech.com/docs/viewing-rewards-catalog-events-in-membercare.md)
  - [Reducing Reward Checkout Failures](https://docs.capillarytech.com/docs/reducing-reward-checkout-failures.md)
  - [Personalizing the Rewards Catalog](https://docs.capillarytech.com/docs/personalizing-the-catalog-with-program-tier-scope.md)
  - [Redeeming Points from User Groups](https://docs.capillarytech.com/docs/redeeming-points-from-user-groups.md)
  - [Ownership concept in Rewards Catalog](https://docs.capillarytech.com/docs/ownership-concept-in-rewards-catalog.md)
  - [Grouping and Ranking in Rewards Catalog](https://docs.capillarytech.com/docs/grouping-and-ranking-in-rewards-catalog.md)
  - [Point Redemption Controls for the Catalog](https://docs.capillarytech.com/docs/point-redemption-controls-for-the-catalog.md)
  - [Different payment modes for rewards in the catalog](https://docs.capillarytech.com/docs/pointscash-journeys-in-rewards-catalog.md)
  - [Reward Tracking with Status and Custom Fields in Reward Fulfillment](https://docs.capillarytech.com/docs/reward-tracking-with-status-and-custom-fields-in-reward-fulfillment.md)
  - [Rewards Event Notification](https://docs.capillarytech.com/docs/rewards-event-notification.md)
  - [Issue Catalog Reward from Loyalty Workflow](https://docs.capillarytech.com/docs/issue-catalog-reward-from-loyalty-workflow.md)
- [Cart Promotions](https://docs.capillarytech.com/docs/cart-promotions.md)
  - [Overview](https://docs.capillarytech.com/docs/overview-.md)
  - [Introduction](https://docs.capillarytech.com/docs/introduction-.md)
  - [Core Concepts](https://docs.capillarytech.com/docs/core-concepts-1.md)
  - [Configuring Cart Promotion Redemption ](https://docs.capillarytech.com/docs/configuring-cart-promotion-redemption.md)
  - [Types of Cart Promotion](https://docs.capillarytech.com/docs/types-of-cart-promotion-.md)
  - [Create and Manage Cart Promotions](https://docs.capillarytech.com/docs/creating-a-cart-promotion-.md)
    - [Create a Cart Promotion](https://docs.capillarytech.com/docs/create-a-cart-promotions.md)
    - [Edit or Disable a Cart Promotion](https://docs.capillarytech.com/docs/editing-or-deleting-a-cart-promotion.md)
    - [Cart Promotion Settings](https://docs.capillarytech.com/docs/cart-promotion-settings-.md)
    - [Preventing Fraudulent Redemptions](https://docs.capillarytech.com/docs/preventing-fraudulent-redemptions.md)
    - [Example Use Cases](https://docs.capillarytech.com/docs/example-use-cases.md)
    - [FAQs](https://docs.capillarytech.com/docs/faq-3.md)
- [Introduction](https://docs.capillarytech.com/docs/introduction-giftvoucher.md)
- [Configure Gift Voucher](https://docs.capillarytech.com/docs/configure-a-gift-voucher.md)
- [Manage Gift Voucher](https://docs.capillarytech.com/docs/manage-gift-voucher.md)
- [Gift Vouchers Settings](https://docs.capillarytech.com/docs/gift-vouchers-settings.md)
- [Settings](https://docs.capillarytech.com/docs/configure-incentive-settings.md)

## User Documentation: INSIGHTS+
- [Overview](https://docs.capillarytech.com/docs/insights-plus-overview.md): This pages helps with you an overview on Insights+.
- [Product navigation](https://docs.capillarytech.com/docs/insights-product-navigation.md)
- [Terms and abbreviations](https://docs.capillarytech.com/docs/terms-and-abbreviations.md): This page provides you with information on terms and abbreviations used in Insights+ module.
- [KPI and dimensions](https://docs.capillarytech.com/docs/kpi-and-dimensions.md): This page provides you information regarding KPIs and dimensions. KPIs and dimensions are one of the building blocks of Insights+.
  - [List of KPIs and Dimensions](https://docs.capillarytech.com/docs/list-of-kpis-and-dimesions.md)
    - [Create Concept Hierarchy on Insights+](https://docs.capillarytech.com/docs/create-concept-hierarchy-on-insights.md)
- [Overview](https://docs.capillarytech.com/docs/create-normal-migration-charts.md)
- [Create Chart](https://docs.capillarytech.com/docs/create-chart.md)
- [View Chart Details](https://docs.capillarytech.com/docs/view-chart-details.md)
- [Edit Chart](https://docs.capillarytech.com/docs/edit-or-modify-chart.md)
- [Delete Chart](https://docs.capillarytech.com/docs/delete-chart.md)
- [Advanced Filter](https://docs.capillarytech.com/docs/advanced-filter.md)
- [Reporting](https://docs.capillarytech.com/docs/reports-and-charts.md)
  - [Types of Reports](https://docs.capillarytech.com/docs/overview-1.md)
  - [Standard Report](https://docs.capillarytech.com/docs/reporting-standard-report.md)
  - [Custom Report](https://docs.capillarytech.com/docs/reporting-custom-report.md)
    - [Overview](https://docs.capillarytech.com/docs/custom-reports-overview.md)
    - [Create and Publish Custom Report](https://docs.capillarytech.com/docs/create.md)
    - [Edit or Delete Custom Report](https://docs.capillarytech.com/docs/edit-or-delete.md)
    - [Share Custom Report](https://docs.capillarytech.com/docs/share-report.md)
    - [Archive Custom Report](https://docs.capillarytech.com/docs/insights-archive-report.md)
  - [Managing Reports](https://docs.capillarytech.com/docs/managing-reports.md)
    - [View or Access Report](https://docs.capillarytech.com/docs/view-or-access-report.md)
    - [Analyse reports Based on Audience Groups](https://docs.capillarytech.com/docs/add-audience-group.md)
    - [Download Report](https://docs.capillarytech.com/docs/download-report.md)
    - [Explore Charts in Reports (Explore Mode)](https://docs.capillarytech.com/docs/explore-charts-in-reports-explore-mode.md)
    - [Apply Dimensions to Charts](https://docs.capillarytech.com/docs/apply-dimensions-to-charts.md)
    - [Target Setting & Tracking at KPI level](https://docs.capillarytech.com/docs/target-setting.md)
    - [Schedule Report](https://docs.capillarytech.com/docs/insights-schedule-report.md)
    - [Share Report URL](https://docs.capillarytech.com/docs/share-report-url.md)
- [Date range filter & comparison with previous period](https://docs.capillarytech.com/docs/date-range-filter-comparison-with-previous-period-1.md)
- [Apply filters in report](https://docs.capillarytech.com/docs/apply-filters-in-report-1.md)
- [Audience group filter in reports](https://docs.capillarytech.com/docs/audience-group-filter-in-reports.md)
- [Fact & Dimension Tables](https://docs.capillarytech.com/docs/fact-dimension-tables.md)
  - [Fact tables](https://docs.capillarytech.com/docs/fact-tables.md)
    - [Bill Line Items Fact Table](https://docs.capillarytech.com/docs/bill-line-items-fact-table.md)
    - [Daily Till Summary Fact Table](https://docs.capillarytech.com/docs/daily-till-summary-fact-table.md)
    - [Payment Details Fact Table](https://docs.capillarytech.com/docs/payment-details-fact.md)
    - [Return Bill Line Item Fact Table](https://docs.capillarytech.com/docs/return-bill-line-item-fact-table.md)
    - [Customer Summary Fact Table](https://docs.capillarytech.com/docs/customer-summary-members-fact-table.md)
    - [Profile Users Fact Table](https://docs.capillarytech.com/docs/profile-users-fact-table.md)
    - [Registration Event Fact Table](https://docs.capillarytech.com/docs/fact_registration-event.md)
    - [Nsadmin Messages Fact Table](https://docs.capillarytech.com/docs/nsadmin-messages-fact-table.md)
    - [Goodwill Requests Fact Table](https://docs.capillarytech.com/docs/goodwill-requests-fact-table.md)
    - [Points Fact Tables](https://docs.capillarytech.com/docs/points-fact-table.md)
    - [Coupons Fact Table](https://docs.capillarytech.com/docs/coupons-fact-table.md)
    - [Badges Fact Table](https://docs.capillarytech.com/docs/badges-fact-table.md)
    - [Streaks Fact Table](https://docs.capillarytech.com/docs/fact_streaks.md)
    - [Journeys Fact Table](https://docs.capillarytech.com/docs/journeys-fact-table.md)
    - [Milestones Fact Table](https://docs.capillarytech.com/docs/fact_milestones.md)
    - [Rewards Fact Tables](https://docs.capillarytech.com/docs/rewards-fact-table.md)
    - [Invitation Sent Fact Table](https://docs.capillarytech.com/docs/invitation-sent-fact-table.md)
    - [Referrals Fact Table](https://docs.capillarytech.com/docs/referrals-fact-table.md)
    - [Referrers Fact Table](https://docs.capillarytech.com/docs/referrers-fact-table.md)
    - [Contact Info Fact Table](https://docs.capillarytech.com/docs/contact-info-fact-table.md)
    - [Response Info Fact Table](https://docs.capillarytech.com/docs/response-info-fact-table.md)
    - [Communication Credits Log Fact Table](https://docs.capillarytech.com/docs/communication-credits-log-fact-table.md)
    - [Email Click Stats Fact Table](https://docs.capillarytech.com/docs/email-click-stats-fact-table.md)
    - [Custom Field Data Fact Table](https://docs.capillarytech.com/docs/custom-field-data-fact-table.md)
    - [Customer Merge Log Fact Table](https://docs.capillarytech.com/docs/customer-merge-log-fact-table.md)
    - [Customer Notes Fact Table](https://docs.capillarytech.com/docs/customer-notes-fact-table.md)
    - [Issue Tracker Fact Table](https://docs.capillarytech.com/docs/issue-tracker-fact-table.md)
    - [Call Task Customer Status Fact Table](https://docs.capillarytech.com/docs/call-task-customer-status-fact-table.md)
    - [Slab Change Log Fact Table](https://docs.capillarytech.com/docs/slab-change-log-fact-table.md)
    - [Earned Promotions Fact Table](https://docs.capillarytech.com/docs/earned-promotions-fact.md)
    - [Issued Promotions Fact Table](https://docs.capillarytech.com/docs/issued-promotions-fact-table.md)
    - [Partner Program Enrollment Fact Table](https://docs.capillarytech.com/docs/partner-program-enrollment-fact-table.md)
    - [Partner Program Slab History Fact Table](https://docs.capillarytech.com/docs/partner-program-slab-history-fact-table.md)
    - [External Partner Program Table](https://docs.capillarytech.com/docs/external-partner-program-table.md)
    - [Partner Program Slab History Fact Table](https://docs.capillarytech.com/docs/partner-program-slab-history-fact-table-1.md)
    - [Supplementary Partner Program Fact Table](https://docs.capillarytech.com/docs/supplementary-partner-program-fact-table.md)
    - [ Partner Program Linking Fact Table](https://docs.capillarytech.com/docs/link.md)
  - [Dimension tables](https://docs.capillarytech.com/docs/dimension-tables.md)
- [Points awarded/deducted scenarios](https://docs.capillarytech.com/docs/1-points-awardeddeducted-scenarios.md)
- [Return after redemption scenarios](https://docs.capillarytech.com/docs/return-after-redemption-scenarios.md)
- [Customer Segmentation](https://docs.capillarytech.com/docs/customer-segmentation.md)
  - [Introduction to customer segmentation](https://docs.capillarytech.com/docs/introduction-to-customer-segmentation.md)
  - [Create segments through file upload](https://docs.capillarytech.com/docs/create-segments-through-file-upload.md)
  - [Create segments using scheduled FTP upload](https://docs.capillarytech.com/docs/create-segments-using-scheduled-ftp-upload.md)
  - [Create segments using filters](https://docs.capillarytech.com/docs/create-segments-using-filters.md)
  - [Segment Creation Using SQL Traits](https://docs.capillarytech.com/docs/segment-creation-using-sql-traits.md)
- [Fraud Management](https://docs.capillarytech.com/docs/fraud-management-insights.md)
  - [Fraud Detection Rules](https://docs.capillarytech.com/docs/fraud-detection-rules.md)
  - [Methodology](https://docs.capillarytech.com/docs/methodology.md)
  - [Use Case for Score Calculation](https://docs.capillarytech.com/docs/use-case-for-score-calculation.md)
  - [FAQs](https://docs.capillarytech.com/docs/faqs-10.md)
- [BI Tool Connector](https://docs.capillarytech.com/docs/bi-tool-connector.md)
  - [Connect Power BI and Tableau Desktop to Databricks](https://docs.capillarytech.com/docs/steps-to-connect-to-bi-tool-powerbi-tableau.md)
  - [Viewing Power BI Dashboards on Insights](https://docs.capillarytech.com/docs/power-bi-dashboards-integration-into-intouch.md)
- [Custom Namespace for Organisation](https://docs.capillarytech.com/docs/configure-custom-namespace-for-organisation.md)
- [Data Encryption Settings](https://docs.capillarytech.com/docs/data-encryption-settings.md)

## User Documentation: REWARDS+
- [Getting Started with Rewards+](https://docs.capillarytech.com/docs/getting-started-with-rewards.md)
- [Rewards+ Overview](https://docs.capillarytech.com/docs/rewards_overview.md)
- [Types of Rewards Supported by Rewards+](https://docs.capillarytech.com/docs/types-of-reward.md)
- [Sources for Rewards+](https://docs.capillarytech.com/docs/sources-for-rewards.md): Rewards+ supports multiple sources for adding rewards
- [Core Components](https://docs.capillarytech.com/docs/core-components.md)
- [BiFrost — CMS Console (Super Admin)](https://docs.capillarytech.com/docs/bifrost-cms-console.md): BiFrost is the affiliate-offers Rewards Catalog operator console — onboard publishers, connect affiliate networks, QC-review ingested offers, and publish them into a publisher's catalog.
- [Ingestion and Extraction (Data import & export)](https://docs.capillarytech.com/docs/ingestion-and-extraction-data-import-export.md): Rewards+ handles data transfer and processing using secure methods and cloud storage. It ensures data is collected, prepared, and stored efficiently and safely.
- [Rewards+ Agent Support Tool](https://docs.capillarytech.com/docs/ast-agent-support-tool.md)
- [Rewards+Dashboard](https://docs.capillarytech.com/docs/rewardsplus_dashboard.md)
- [Example and Sample Rewards+ UI](https://docs.capillarytech.com/docs/use-case-.md)

## User Documentation: DEVELOPER DOCS
- [Neo Extension (API Extension)](https://docs.capillarytech.com/docs/extension.md)
  - [Quickstart for Neo Extension](https://docs.capillarytech.com/docs/neo-quick-start.md)
  - [Use Cases](https://docs.capillarytech.com/docs/neo-use-cases.md)
    - [Customer Name Validation for Loyalty Point Allocation](https://docs.capillarytech.com/docs/name-validation-for-loyalty-point-allocation.md)
    - [Asynchronous High-Volume Data Processing for Loyalty Point Allocation](https://docs.capillarytech.com/docs/kafka-implementation-in-neo.md)
    - [Event Notification Enrichment](https://docs.capillarytech.com/docs/event-notification-enrichment.md)
  - [Introduction](https://docs.capillarytech.com/docs/introduction-to-extension-platform.md)
    - [Overview](https://docs.capillarytech.com/docs/overview-neo.md)
    - [Enabling & Managing Access to Neo](https://docs.capillarytech.com/docs/access-management-neo.md)
    - [Introduction to the UI](https://docs.capillarytech.com/docs/introduction-to-the-ui-neo.md)
  - [Core Concepts](https://docs.capillarytech.com/docs/core-concepts.md)
    - [Dataflow & Building Blocks](https://docs.capillarytech.com/docs/dataflows.md)
    - [Block Libraries](https://docs.capillarytech.com/docs/block-libraries.md)
  - [Configuration & Setup](https://docs.capillarytech.com/docs/configuration-setup.md)
    - [Configuring Conditions](https://docs.capillarytech.com/docs/configuring-conditions.md)
    - [Configuring Relations](https://docs.capillarytech.com/docs/configuring-relations.md)
    - [Configuring Caching](https://docs.capillarytech.com/docs/configuring-caching.md)
  - [Building Block Configuration](https://docs.capillarytech.com/docs/building-block-configuration-neo.md)
    - [Trigger Block](https://docs.capillarytech.com/docs/trigger.md)
    - [Schema Block](https://docs.capillarytech.com/docs/json-schema-block.md)
    - [Script Block](https://docs.capillarytech.com/docs/script-block.md)
    - [API Request Block](https://docs.capillarytech.com/docs/api-request-block.md)
    - [GET Mongo Block](https://docs.capillarytech.com/docs/get-mongo.md)
    - [PUT Mongo Block](https://docs.capillarytech.com/docs/put-mongo.md)
    - [Bulk Upsert Mongo Block](https://docs.capillarytech.com/docs/bulk-upsert-mongo.md)
    - [Redis Evict Block](https://docs.capillarytech.com/docs/redis-evict.md)
    - [Kafka Block](https://docs.capillarytech.com/docs/neo-kafka-block.md)
    - [HMAC Block](https://docs.capillarytech.com/docs/hmac-block.md)
    - [Encrypt Block](https://docs.capillarytech.com/docs/encrypt-block.md)
    - [Decrypt Block](https://docs.capillarytech.com/docs/decrypt-block.md)
    - [OAuth Block](https://docs.capillarytech.com/docs/capillarys-oauth-block.md)
    - [OrgContextSwitch Block](https://docs.capillarytech.com/docs/orgcontextswitch-block.md)
    - [Cache Manager Block](https://docs.capillarytech.com/docs/cachemanager-executor.md)
  - [Manage Dataflow](https://docs.capillarytech.com/docs/manage-dataflow.md)
    - [Composing a Dataflow](https://docs.capillarytech.com/docs/composing-a-neo_dataflow.md)
    - [Review and Approval of a Dataflow](https://docs.capillarytech.com/docs/review-and-approval-of-a-dataflow.md)
    - [Dataflow States](https://docs.capillarytech.com/docs/dataflow-states.md)
    - [Editing a Dataflow](https://docs.capillarytech.com/docs/editing-a-dataflow.md)
    - [Deactivating and Activating a Dataflow](https://docs.capillarytech.com/docs/deactivating-a-dataflow.md)
    - [Viewing Dataflow List](https://docs.capillarytech.com/docs/viewing-dataflow-list.md)
    - [Promoting Dataflows Across Organizations](https://docs.capillarytech.com/docs/promote-dataflow.md): Copy approved dataflows from one organization to another
    - [Neo DAO Functions](https://docs.capillarytech.com/docs/neo-dao-functions.md)
  - [Organize Dataflows](https://docs.capillarytech.com/docs/organize-dataflows.md)
    - [Organizing Dataflows using Tags & Filters](https://docs.capillarytech.com/docs/tags-filters-in-dataflow.md)
    - [Organizing Dataflows using Applications](https://docs.capillarytech.com/docs/using-applications.md)
  - [Execution & Monitoring](https://docs.capillarytech.com/docs/connectplus-execution-monitoring.md)
  - [Advanced Features](https://docs.capillarytech.com/docs/advanced-features.md)
    - [Access Sensitive Data in Neo Dataflows Using Configuration Manager](https://docs.capillarytech.com/docs/configuration-manager.md)
    - [Dataflow Versioning](https://docs.capillarytech.com/docs/approval-flow.md)
  - [AI-Assisted Dataflow Creation in Neo using Aira Coder](https://docs.capillarytech.com/docs/ai-neo-dataflow.md)
    - [Overview](https://docs.capillarytech.com/docs/overview-neo-ai.md)
    - [Create a Dataflow](https://docs.capillarytech.com/docs/create-a-dataflow-using-ai.md)
    - [Modify a Dataflow](https://docs.capillarytech.com/docs/update-a-dataflow-using-ai.md)
    - [Copy and Paste a Dataflow](https://docs.capillarytech.com/docs/copy-and-paste-a-dataflow.md)
    - [Summarize a Dataflow](https://docs.capillarytech.com/docs/explain-dataflow-neo-ai.md)
    - [Ask Documentation Related Questions](https://docs.capillarytech.com/docs/ask-documentation-related-questions.md)
    - [Known Limitations](https://docs.capillarytech.com/docs/known-limitation-new-ai.md)
  - [FAQs](https://docs.capillarytech.com/docs/faqs-neo.md)
- [Vulcan (UI Extension)](https://docs.capillarytech.com/docs/vulcan.md)
  - [Examples](https://docs.capillarytech.com/docs/examples-of-ui-creation.md)
    - [Creating a Microsite Using Vulcan](https://docs.capillarytech.com/docs/creating-a-microsite-using-vulcan.md)
    - [Customising the Member Care UI](https://docs.capillarytech.com/docs/customizing-the-member-care-ui.md)
  - [Introduction](https://docs.capillarytech.com/docs/introduction-vulcan.md)
  - [Getting Started](https://docs.capillarytech.com/docs/vulcan-getting-started.md)
  - [Application Development Process](https://docs.capillarytech.com/docs/application-development-process.md)
  - [API Management on Vulcan](https://docs.capillarytech.com/docs/api_management_on_vulcan.md)
  - [Troubleshooting](https://docs.capillarytech.com/docs/vulcan-troubleshooting.md)
  - [FAQs](https://docs.capillarytech.com/docs/vulcan_faq.md)
- [Dev Console (Console)](https://docs.capillarytech.com/docs/dev-console.md)
  - [Introduction](https://docs.capillarytech.com/docs/introduction-dev-console.md)
  - [Handle Deployment](https://docs.capillarytech.com/docs/handle-deployment.md)
  - [View API Logs](https://docs.capillarytech.com/docs/log-viewer.md)
  - [View API Performance Metrics](https://docs.capillarytech.com/docs/platform-metrics.md)
  - [View App Request Logs](https://docs.capillarytech.com/docs/view-app-request-logs.md)
  - [Save Extension Configurations](https://docs.capillarytech.com/docs/extension-configuration.md)
  - [Connect and Manage DB](https://docs.capillarytech.com/docs/db-management.md)
  - [Alert Management](https://docs.capillarytech.com/docs/alert-management.md)
  - [FAQs](https://docs.capillarytech.com/docs/faqs-dev-console.md)
- [SDKs](https://docs.capillarytech.com/docs/sdks.md)
  - [Android SDK](https://docs.capillarytech.com/docs/android-sdk.md)
    - [Getting Started](https://docs.capillarytech.com/docs/android-sdk-getting-started.md): This guide provides an overview about Capillary's Android SDK.
    - [Configure Firebase](https://docs.capillarytech.com/docs/configure-firebase.md): This section helps you with information on configurations that you need to do on Firebase.
    - [Configure Source Account](https://docs.capillarytech.com/docs/set-up-source-account.md): This section provides you with information on how to set up a source account and set the connection between SDK and the org.
    - [Configure Gateway](https://docs.capillarytech.com/docs/configure-gateway.md)
    - [Install SDK](https://docs.capillarytech.com/docs/installing-sdk.md): This section provides information on how to install SDK.
    - [Initialise SDK](https://docs.capillarytech.com/docs/sdk-initialisation.md): This section provides information on initialisation of the SDK.
    - [Configure Push Notifications](https://docs.capillarytech.com/docs/push-notification.md): This page provides you with information on push notifications and how to configure it.
    - [Configure In-app Messaging](https://docs.capillarytech.com/docs/in-app-messaging.md): This page provides you with information on IN-app messaging feature.
    - [Configure Notification Center](https://docs.capillarytech.com/docs/configure-notification-center.md): This page provides information about notification center and how to configure it.
    - [Configure Gamification (Experience+)](https://docs.capillarytech.com/docs/gamification-android.md): Add Capillary's Experience+ gamification campaigns and views to your Android app.
    - [API Reference for Event Tracking and User Lifecycle Management](https://docs.capillarytech.com/docs/android-sdk-api-reference.md)
    - [Xiaomi push notification (Push Amplification)](https://docs.capillarytech.com/docs/xiaomi-push-notification.md): This page provides you with information on configuring push notifications on Chinese OEM devices.
  - [iOS SDK](https://docs.capillarytech.com/docs/ios-sdk.md)
    - [Getting Started](https://docs.capillarytech.com/docs/ios-sdk-getting-started.md): This guide provides information on how to integrate your mobile apps with Capillary iOS SDK.
    - [Configure Source Account](https://docs.capillarytech.com/docs/set-up-source-account-ios.md)
    - [Configure gateway](https://docs.capillarytech.com/docs/configure-gateway-ios.md)
    - [Install SDK](https://docs.capillarytech.com/docs/install-sdk.md): This guide provides information on how to integrate your mobile apps with Capillary's iOS SDK.
    - [Initialise SDK](https://docs.capillarytech.com/docs/initialise-ios-sdk.md): This section provides information on initialisation of the iOS SDK.
    - [Core Features](https://docs.capillarytech.com/docs/core-features.md)
    - [Configure Push Notifications](https://docs.capillarytech.com/docs/configure-push-notifications.md): This page provides you with information on push notifications and how to configure it.
    - [Configure Rich Push Notifications](https://docs.capillarytech.com/docs/rich-push-notifications.md)
    - [Configure In-app Messaging](https://docs.capillarytech.com/docs/in-app-messaging_ios.md): This page provides you with information on In-app messaging feature.
    - [Configure Notification Inbox](https://docs.capillarytech.com/docs/configure-notification-center_ios.md): This page provides information about notification inbox and how to configure it.
    - [Configure Gamification (Experience+)](https://docs.capillarytech.com/docs/gamification-ios.md): Add Capillary's Experience+ gamification campaigns and views to your iOS app.
    - [API Reference for Event Tracking and User Lifecycle Management](https://docs.capillarytech.com/docs/ios-sdk-api-reference.md)
  - [React Native SDK](https://docs.capillarytech.com/docs/setting-up-react-native-project-for-hydra-sdk.md): This document describes how to set up the React Native wrapper bridge using Hydra Native SDKs.
    - [Getting Started](https://docs.capillarytech.com/docs/react-native-sdk-getting-started.md)
    - [Install React Native SDK](https://docs.capillarytech.com/docs/react-native-sdk-install.md)
    - [React Native Setup Overview](https://docs.capillarytech.com/docs/react-native-sdk-setup-overview.md)
    - [Configure Push Notifications](https://docs.capillarytech.com/docs/react-native-sdk-push-notifications.md)
    - [Configure In-App Messaging](https://docs.capillarytech.com/docs/react-native-sdk-in-app-messaging.md)
    - [Configure Notification Center](https://docs.capillarytech.com/docs/react-native-sdk-notification-center.md): This document outlines the steps to integrate Notification Center into your React Native project using the Hydra SDK. Follow the instructions below to enable and configure Notification Center for…
    - [Configure Gamification (Experience+)](https://docs.capillarytech.com/docs/gamification-react-native.md): Add Capillary's Experience+ gamification campaigns and views to your React Native app.
    - [API Reference for Event Tracking, Notifications, and User Lifecycle](https://docs.capillarytech.com/docs/react-native-sdk-api-reference.md)
  - [Flutter SDK](https://docs.capillarytech.com/docs/flutter-sdk.md)
    - [Getting Started](https://docs.capillarytech.com/docs/flutter-sdk-getting-started.md)
    - [Install Flutter SDK](https://docs.capillarytech.com/docs/flutter-sdk-install.md)
    - [Advanced Platform Setup](https://docs.capillarytech.com/docs/flutter-sdk-advanced-setup.md)
    - [Flutter Setup Overview](https://docs.capillarytech.com/docs/flutter-setup-overview.md)
    - [Configure Push Notifications](https://docs.capillarytech.com/docs/flutter-sdk-push-notifications.md)
    - [Configure In-App Messaging](https://docs.capillarytech.com/docs/flutter-sdk-in-app-messaging.md)
    - [Configure Notification Center](https://docs.capillarytech.com/docs/configuring-notification-center.md)
    - [Configure Gamification (Experience+)](https://docs.capillarytech.com/docs/gamification-flutter.md): Add Capillary's Experience+ gamification campaigns and views to your Flutter app.
    - [API Reference for Event Tracking, Notifications, and User Lifecycle](https://docs.capillarytech.com/docs/flutter-sdk-api-reference.md)
  - [Web SDK](https://docs.capillarytech.com/docs/web-sdk.md)
    - [Getting Started](https://docs.capillarytech.com/docs/web-sdk-getting-started.md): This guide provides an overview about Capillary's Web SDK.
    - [Prerequisites](https://docs.capillarytech.com/docs/prerequisites.md)
    - [Install SDK](https://docs.capillarytech.com/docs/web-sdk-install.md): This section provides information on how to install the SDK.
    - [Initialise SDK](https://docs.capillarytech.com/docs/web-sdk-initialisation.md): This section provides information on initialisation of the SDK.
    - [Configure Firebase](https://docs.capillarytech.com/docs/configure-firebase-web.md): This section provides information on setting up a Firebase project for the Web SDK.
    - [Configure Push Notifications](https://docs.capillarytech.com/docs/push-notification-web.md): This page provides you with information on push notifications and how to configure them.
    - [Configure Gamification (Experience+)](https://docs.capillarytech.com/docs/gamification-web.md): Add Capillary's Experience+ gamification campaigns, entry points, and loyalty embeds to your Web app.
    - [API Reference for Event Tracking, Notifications, and User Lifecycle](https://docs.capillarytech.com/docs/web-sdk-api-reference.md): Reference for every public method on the Capillary Web SDK.
    - [AI-Assisted Integration Guide](https://docs.capillarytech.com/docs/web-sdk-ai-integration-guide.md): A copy-paste prompt that lets an AI coding assistant (Cursor, GitHub Copilot, Claude Code, etc.) wire the Capillary Web SDK into your project automatically.
    - [Validation, Troubleshooting & Rollback](https://docs.capillarytech.com/docs/web-sdk-troubleshooting.md): Validate your Web SDK integration, troubleshoot common issues, and roll back if needed.

## User Documentation: ADMIN CONTROLS
- [Organization](https://docs.capillarytech.com/docs/organisation.md)
  - [Independent organization](https://docs.capillarytech.com/docs/organization-management.md)
  - [Organization Units (OU)](https://docs.capillarytech.com/docs/organisation-units-ou.md)
  - [Connected Organizations](https://docs.capillarytech.com/docs/connected-organizations.md)
    - [Entity-specific Behaviour in a Connected Organization ](https://docs.capillarytech.com/docs/entity-specific-behaviour-in-a-connected-organization.md)
  - [Organization Management](https://docs.capillarytech.com/docs/org-management.md)
- [User Management](https://docs.capillarytech.com/docs/new-user-management.md)
  - [Overview](https://docs.capillarytech.com/docs/new-user-management-overview.md)
  - [Types of Users in the Organization](https://docs.capillarytech.com/docs/types-of-users-in-the-organisation.md)
  - [Managing Permissions for the Users](https://docs.capillarytech.com/docs/managing-permissions.md)
    - [List of Standard Permission Sets](https://docs.capillarytech.com/docs/list-of-standard-permission-sets.md)
    - [Manage Custom Permission Sets](https://docs.capillarytech.com/docs/custom-permission-sets.md)
    - [Assign Permission Set to Users](https://docs.capillarytech.com/docs/assigning-permission-set-to-users.md)
    - [Manage Permission for Users in Multiple Organizations](https://docs.capillarytech.com/docs/managing-permission-for-users-in-multiple-orgs.md)
  - [Onboarding and Managing Users](https://docs.capillarytech.com/docs/onboarding-user.md)
  - [FAQs on User Management](https://docs.capillarytech.com/docs/faqs-on-user-management.md)
  - [Audit Logs](https://docs.capillarytech.com/docs/audit-logs.md)
- [Credit management](https://docs.capillarytech.com/docs/credit-management.md)
- [Setup Localization](https://docs.capillarytech.com/docs/language.md)
- [Localisation management](https://docs.capillarytech.com/docs/translation-management.md)
- [Single Sign On (SSO)](https://docs.capillarytech.com/docs/sso-integration.md): In this section, you will find details on how to enable and integrate Single Sign-On (SSO).
- [API Gateway Integration with CIAM Platforms](https://docs.capillarytech.com/docs/api-gateway-integration-with-ciam-platforms.md)
- [API Security](https://docs.capillarytech.com/docs/api-access.md): This section provides you with information on how Capillary handles API security.
  - [Authentication](https://docs.capillarytech.com/docs/api-client.md): This page provides you with information on enabling basic auth and creating API client key and secret.
  - [Authorization](https://docs.capillarytech.com/docs/access-group.md): This page provides you with information on creating access controls and setting authorization for APIs.
- [Setup Subscription](https://docs.capillarytech.com/docs/subscription_management.md)
- [Unified Subscription](https://docs.capillarytech.com/docs/setup-unified-subscription.md): This page provides you with information on unified subscription.
- [Classify Data as PSI and PII](https://docs.capillarytech.com/docs/marking-custom-fields-extended-fields-as-psi-and-pii.md)
- [Setup OTP Verification Rules](https://docs.capillarytech.com/docs/setup-otp-verification-rules.md): This page provides you with information on OTP configurations.
- [Data Deletion](https://docs.capillarytech.com/docs/pii-configuration.md): This section provides you with information on how to enable PII deletion and about the PII data deletion workflow.
  - [Introduction](https://docs.capillarytech.com/docs/introduction-data-deletion.md)
  - [Performing Data Deletion](https://docs.capillarytech.com/docs/performing-data-deletion.md)
  - [How Data Deletion Works and What Data is Deleted](https://docs.capillarytech.com/docs/how-data-deletion-works-and-what-data-is-deleted.md)
  - [Handling Customer Cards During Data Deletion](https://docs.capillarytech.com/docs/handling-customer-cards-during-pii-deletion.md)
  - [FAQs](https://docs.capillarytech.com/docs/data-deletion-faq.md)
- [Data Masking](https://docs.capillarytech.com/docs/data-masking.md)
  - [Overview of Data Masking](https://docs.capillarytech.com/docs/introduction-datamasking.md)
  - [How Masking is Enforced in Databricks](https://docs.capillarytech.com/docs/how-masking-is-enforced-in-databricks.md)
  - [Mask OTPs](https://docs.capillarytech.com/docs/mask-otps.md): This page provides you with information on masking OTPs.
- [ InTouch password security and account lockout](https://docs.capillarytech.com/docs/intouch-password-security-and-account-lockout.md): InTouch protects user accounts through secure password storage and automatic account lockout after repeated failed login attempts. This page describes both mechanisms for security reviews and audit…
- [Channel configuration](https://docs.capillarytech.com/docs/channel-configuration.md): This page provides you with information on communication/source channels in the Capillary platform.
- [Reset Password Using Import](https://docs.capillarytech.com/docs/reset-password-using-import.md)
- [Identity Access Management](https://docs.capillarytech.com/docs/identity-access-management.md)
  - [Overview](https://docs.capillarytech.com/docs/overview-iam.md)
  - [Customer IAM (CIAM) for end customers](https://docs.capillarytech.com/docs/customer-iam-ciam-for-end-customers.md)
    - [Auth for First-Party Apps](https://docs.capillarytech.com/docs/auth-for-first-party-apps.md)
    - [oAuth2 Authorization Code Flow and SSO for Partner Apps - Using Ory Hydra](https://docs.capillarytech.com/docs/oauth2-authorization-code-flow-and-sso-for-partner-apps-using-ory-hydra.md)
    - [Integration with External CIAMs](https://docs.capillarytech.com/docs/integration-with-external-ciams.md)
  - [Machine-to-machine (M2M) IAM for services](https://docs.capillarytech.com/docs/machine-to-machine-m2m-iam-for-services.md)
    - [OAuth2 Client Credentials Flow](https://docs.capillarytech.com/docs/oauth2-client-credentials-flow.md)
    - [Basic Authentication](https://docs.capillarytech.com/docs/basic-authentication-api.md)
  - [Workforce IAM for Employees](https://docs.capillarytech.com/docs/workforce-iam-for-employees.md)
    - [Single Sign On (SSO) Using Okta](https://docs.capillarytech.com/docs/single-sign-on-sso-using-okta.md)
  - [Authentication Scenarios and Recommendations](https://docs.capillarytech.com/docs/authentication-scenarios-and-recommendations.md)

## User Documentation: ANNOUNCEMENTS
- [January-February-March 2026](https://docs.capillarytech.com/docs/january-februar-march-2026.md)
- [April - May - June 2026](https://docs.capillarytech.com/docs/april-may-june-2026.md)
- [July - August - September 2026](https://docs.capillarytech.com/docs/july-august-september-2026.md)
- [January-February-March 2025](https://docs.capillarytech.com/docs/january-february-march-2025.md)
- [April - May - June 2025](https://docs.capillarytech.com/docs/april-may-june-2025.md)
- [July - August - September 2025](https://docs.capillarytech.com/docs/july-august-september-2025.md)
- [October-November-December 2025](https://docs.capillarytech.com/docs/october-november-december-2025.md)
- [January-February-March 2024](https://docs.capillarytech.com/docs/january-february-march24.md)
- [April-May-June 2024](https://docs.capillarytech.com/docs/april-may-june24.md)
- [July-August-September 2024](https://docs.capillarytech.com/docs/july-august-september24.md)
- [October-November-December 2024](https://docs.capillarytech.com/docs/october-november-december24.md)
- [January-February-March 2023](https://docs.capillarytech.com/docs/january-february-march23.md)
- [April-May-June 2023](https://docs.capillarytech.com/docs/april-may-june23.md)
- [July-August-September 2023](https://docs.capillarytech.com/docs/july-august-september23.md)
- [October-November-December 2023](https://docs.capillarytech.com/docs/october-november-december23.md)
- [January-February-March 2022](https://docs.capillarytech.com/docs/january-february-march22.md)
- [April-May-June 2022](https://docs.capillarytech.com/docs/april-may-june22.md)
- [July-August-September 2022](https://docs.capillarytech.com/docs/july-august-september22.md)
- [October-November-December 2022](https://docs.capillarytech.com/docs/october-november-december22.md)
- [January-February-March 2021](https://docs.capillarytech.com/docs/january-february-march21.md)
- [April-May-June 2021](https://docs.capillarytech.com/docs/april-may-june21.md)
- [July-August-September 2021](https://docs.capillarytech.com/docs/july-august-september21.md)
- [October-November-December 2021](https://docs.capillarytech.com/docs/october-november-december21.md)

## User Documentation: MCP SERVER
- [MCP](https://docs.capillarytech.com/docs/mcp.md)

## User Documentation: PARTNER INTEGRATIONS
- [Adobe Integration ](https://docs.capillarytech.com/docs/capillary-adobe-integration.md)
  - [Overview](https://docs.capillarytech.com/docs/adobe-integration-overview.md)
  - [Integration Set-up (Capillary to Adobe)](https://docs.capillarytech.com/docs/integration-adobe.md)
  - [Data Migration - Capillary to Adobe](https://docs.capillarytech.com/docs/data-migration.md)
  - [Supported Events](https://docs.capillarytech.com/docs/supported-events.md)
- [SendGrid](https://docs.capillarytech.com/docs/sendgrid.md)
- [Vendor Integration other than SendGrid](https://docs.capillarytech.com/docs/vendor-integration-other-than-sendgrid.md)
- [Vendor integration other than supported vendors](https://docs.capillarytech.com/docs/vendor-integration-other-than-supported-vendors.md)

## API Documentation: API DOCUMENTATION
- [Overview](https://docs.capillarytech.com/reference/apioverview.md): This page gives you the overview of Capillary APIs.
- [Authentication](https://docs.capillarytech.com/reference/authentication.md): This page provides you information regarding the authentications used in API Capillary APIs.
  - [OAuth](https://docs.capillarytech.com/reference/oauth.md): This page provides you with information on how to authenticate APIs using OAuth.
  - [Basic authentication](https://docs.capillarytech.com/reference/basic-authentication.md): This page provides you wit information on how to authenticate the APIs using basic authentication.
  - [Auth for consumer or end-customer apps](https://docs.capillarytech.com/reference/auth-for-consumer-or-end-customer-apps.md): This page provides information on authentication for consumer end web and applications.
- [Authorisation](https://docs.capillarytech.com/reference/authorisation.md): This page provides information on authorisation controls in Capillary APIs.
- [Rate limits](https://docs.capillarytech.com/reference/rate-limits.md): This page provides you information regarding the rate limit of the APIs.
- [API status codes](https://docs.capillarytech.com/reference/errors-and-warnings.md): This page provides you information regarding the errors and warnings that might occur during API calls.
- [Timezone Management in APIs](https://docs.capillarytech.com/reference/timezone-management.md): Browse the timezone management reference pages, including overview, API behavior, configuration, limitations, and FAQ.
  - [Overview](https://docs.capillarytech.com/reference/timezone-management-api-overview.md): This page gives you the overview of Timezone management across APIs, transactions, behavioural events, rewards, and event notifications. .
  - [How Date and Time Values are Handled](https://docs.capillarytech.com/reference/handling-datetime-in-apis.md): This page provides you with information on date and time handling across APIs.
  - [ Exceptions and Known Limitations](https://docs.capillarytech.com/reference/exceptions-and-known-limitations.md): The sections above describe the standardized timezone model that applies across most of the platform. The following are exceptions or known limitations where the model does not apply or is incomplete.
  - [List of APIs with Additional Timezone Fields](https://docs.capillarytech.com/reference/apis-updated-with-additional-timezone-fields.md): This page provides you with information on timezone related date-time fields in the APIs.
  - [FAQ](https://docs.capillarytech.com/reference/timezone-faq.md): Find answers to common questions about timezone standardization, API behavior, offset handling, data storage, and edge cases across the platform.
- [Make Your First API Request](https://docs.capillarytech.com/reference/make-your-first-api-call.md): In this page, you will learn to make your first Capillary API call.
- [Idempotency](https://docs.capillarytech.com/reference/idempotency.md)
- [API Reference Guide](https://docs.capillarytech.com/reference/api-reference-guide.md)
- [Customer (V1)](https://docs.capillarytech.com/reference/customer.md)
  - [Add Customer](https://docs.capillarytech.com/reference/add-customer.md): Endpoint for POST /v1.1/customer/add
  - [Update customer details](https://docs.capillarytech.com/reference/update-customer-details_v1api.md): Let's you update the details of an existing customer other than primary or secondary identifiers. If any of the identifiers you pass already exists for a different account, then the customer details…
  - [update-customer-identifiers](https://docs.capillarytech.com/reference/update-customer-identifiers.md)
  - [Search Customers](https://docs.capillarytech.com/reference/search-customers.md): Lets you fetch customers based on partial or complete keywords passed. You can fetch customers by name, customer identifier, registered store id, registered date, loyalty points, lifetime points,…
  - [Get customer details](https://docs.capillarytech.com/reference/get-customer-details-v1api.md): Retrieve details of a specific loyalty customer such as loyalty information, subscription status, 10 recent transactions, active coupons, recent store interactions, custom fields, extended fields,…
  - [Get Customer Transactions](https://docs.capillarytech.com/reference/get-customer-transactions.md): Retrieves transaction history of a customer which includes the following information. Transaction type, gross transaction amount, transaction date, points issued, points redeemed, coupons redeemed…
  - [Get Customer Redemptions](https://docs.capillarytech.com/reference/get-customer-redemptions.md): This API allows you to retrieve points and coupons redemption history of a customer. You can filter the results by type, duration, coupon ids start with, and coupon ids end with. Besides filters you…
  - [Add/Update Customer Notes](https://docs.capillarytech.com/reference/addupdate-customer-notes.md): This API allows you to capture additional information about the customer.
  - [Get Customer Notes](https://docs.capillarytech.com/reference/get-customer-notes.md): Retrieves notes of a specific customer.
  - [Get Customer Interactions](https://docs.capillarytech.com/reference/get-customer-interactions.md): Lets you fetch store interactions with a specific customer. This includes SMSs, emails, sent to the customer; missed calls received from the customer’s registered mobile number; and surveys submitted…
  - [Get Referral Details](https://docs.capillarytech.com/reference/get-referral-details.md): Retrieves the stats of the referrals along with the unique referral code of a specific customer.
  - [Add/Update Customer Preferences](https://docs.capillarytech.com/reference/addupdate-customer-preferences.md): Preferences are custom fields created under the preferences category which helps in capturing specific interests of a customer. Example: favorite color, favorite brand. This API allows you to set or…
  - [Get Customer Preferences](https://docs.capillarytech.com/reference/get-customer-preferences.md): Retrieves preferences of a specific customer.
  - [Update Subscription Details](https://docs.capillarytech.com/reference/update_subscription_details.md): This API allows you to update SMS/email subscription details of a customer.
  - [Get Subscription Details](https://docs.capillarytech.com/reference/get-subscription-details-1.md): Retrieves SMS and email subscription details of a customer. You can filter the results by priority and communication channel. To retrieve subscription details of multiple customers, pass each…
  - [Change identifier on Auth engine](https://docs.capillarytech.com/reference/change_identifier-on-auth-engine.md): This API enables you to change identifier values in the Auth engine database.
- [Customer (V2)](https://docs.capillarytech.com/reference/customer-1.md)
  - [Add Customer](https://docs.capillarytech.com/reference/v2-add-customer.md): Lets you register customers in the org’s loyalty program or just register their identifiers across sources such as InStore, Facebook,Webengage, WeChat, Martjack, TMall, Taobao, JD, ecommerce, Line,…
  - [Update Customer Details](https://docs.capillarytech.com/reference/update-customer-detail.md): Lets you update existing customer details.
  - [Add or Remove Customer Identifiers](https://docs.capillarytech.com/reference/update-identifiersissue-card.md): API to add or remove identifiers associated with a customer's profile.
  - [Associate Customer](https://docs.capillarytech.com/reference/associate-customer.md): Lets you batch register customers, or associate a customer with company or hierarchy. This API registers parent and child customers (if not registered), and associates the customer with hierarchy…
  - [Get Customer Details](https://docs.capillarytech.com/reference/get-customer-details-v2.md): Retrieves the details of a customer from a specific source. Use `embed` to other parameters to fetch specific details required.
  - [Get customer hierarchy in a user group](https://docs.capillarytech.com/reference/customer-hierarchy.md): Retrieves all child customers for a parent customer.
  - [Update association details](https://docs.capillarytech.com/reference/update-association-details.md): Lets you update group customer details.
  - [Search Customers](https://docs.capillarytech.com/reference/search-customers-1.md): Fetches customers from all sources using query string.    For example, you can fetch customers whose identifiers starting with 99455, or name that starts with ‘john’ and so on.
  - [Update Subscription Details](https://docs.capillarytech.com/reference/update-subscription-details.md)
  - [Get Subscription Details](https://docs.capillarytech.com/reference/get-subscription-details-1-1.md)
  - [Get Customer Tracker Details](https://docs.capillarytech.com/reference/get_v2-customers-customerid-trackers.md): Fetches tracker details for a specific customer.
  - [Get Loyalty Events](https://docs.capillarytech.com/reference/get-loyalty-events.md): Retrieves the details of loyalty events triggered for the customer.
  - [Get Loyalty Details](https://docs.capillarytech.com/reference/get-loyalty-details-1.md): Retrieves the loyalty information of a customer across all loyalty programs of the org . You can also fetch details of a specific loyalty program.
  - [Get Customer Tier](https://docs.capillarytech.com/reference/get-customer-tier.md): Retrieves tier details of a customer for a single program or across all programs of the org.  **This is a light API**.
  - [Get Detailed Customer Coupon Data](https://docs.capillarytech.com/reference/get-customer-coupons-detailed.md)
  - [Get Retro Requests](https://docs.capillarytech.com/reference/get-retro-requests.md): Retrieves the transaction retro requests of the customer.
  - [Get Identifier Change Requests](https://docs.capillarytech.com/reference/get-identifier-change-requests.md): Retrieves the details of identifiers (mobile number/email ID/external ID)change requests. You can also fetch change requests of a specific identifier type using the query parameters.
  - [Get Goodwill Requests](https://docs.capillarytech.com/reference/get-goodwill-requests.md): Retrieves the history of goodwill points of a customer.
  - [Add Customer Image](https://docs.capillarytech.com/reference/add-customer-image.md): Sets profile image for a customer.
  - [Delete Customer Image](https://docs.capillarytech.com/reference/delete-customer-image.md): Deletes the profile image that is set for a customer.
  - [Get Customer Status Log](https://docs.capillarytech.com/reference/get-status-log-1.md): Retrieves the log of customer status changes.
  - [Get Customer Subscription Log](https://docs.capillarytech.com/reference/get-customer-subscription-log.md): Retrieves the log of subscription status changes of a customer.
  - [Get user group customer tracker details](https://docs.capillarytech.com/reference/get-user-group-customer-tracker-details.md): This API enables you to retrieve tracker details of a customer in a user group.
  - [Get customer transactions](https://docs.capillarytech.com/reference/v2api-get-customer-transactions.md): This API retrieves transaction details of a customer using customer ID.
  - [Get Customer Interactions](https://docs.capillarytech.com/reference/v2get-customer-interactions.md): Lets you to fetch store interactions with a specific customer. This includes SMSs, emails, sent to the customer; missed calls received from the customer’s registered mobile number; and surveys…
  - [Status codes](https://docs.capillarytech.com/reference/status-codes-customer.md)
  - [Manual Tier Adjustment](https://docs.capillarytech.com/reference/manual-tier-adjustment.md)
- [Customer (V2 Lookup)](https://docs.capillarytech.com/reference/customer-lookup.md): Customer Lookup is an extension to normal customer APIs. Here, instead of identifying a customer using userId, you can use registered identifiers like mobile number, email ID, external ID, card…
  - [Update Customer Details](https://docs.capillarytech.com/reference/update-customers-lookup.md): Lets you update customer details using the registered identifiers of the customer.
  - [Get Customer Details ](https://docs.capillarytech.com/reference/get-customer-details.md): Retrieves all the details of a customer. Use `embed`  and other parameters to get a specific information as per needed.
  - [Get Customer ID](https://docs.capillarytech.com/reference/get-customer-id.md): Lets you fetch unique ID of a customer generated internally. This is required for customer related activities such as fetch customer details, update customer details, manage subscription details and…
  - [Update Customer Status](https://docs.capillarytech.com/reference/update-customer-status.md): Lets you update a customer's status label.
  - [Get Subscription Details](https://docs.capillarytech.com/reference/get-subscription-details.md): Retrieves the subscription details of a customer to different channels - SMS, email and WeChat.  The status will be `OPTIN` for subscribed and `OPTOUT` for unsubscribed.
  - [Get Customer Loyalty Details](https://docs.capillarytech.com/reference/get-customer-loyalty-details.md): Retrieves the loyalty information of a customer across all loyalty programs of the org . You can also fetch details of a specific loyalty program.
  - [Get Retro Requests](https://docs.capillarytech.com/reference/lookup-get-retro-requests.md): Retrieves the summary of change in identifiers and other details such as email ID, mobile number, external ID, account merge, address change, mobile number reallocation, tier, and retro transactions.
  - [Add Customer Image](https://docs.capillarytech.com/reference/set-customer-image-1.md): Lets you add profile image for a customer.
  - [Get Referrals (Lookup)](https://docs.capillarytech.com/reference/get-referrals-lookup.md): Retrieves the referee details of a customer (referral).
  - [Get Customer Recommendations](https://docs.capillarytech.com/reference/get-customer-recommendations.md): Retrieves the SKUs and product recommendation details for a customer.
  - [Get Points Balance](https://docs.capillarytech.com/reference/get_points_balance.md): Retrieves points balance of a customer from a single program or all programs of the org. Points are aggregated for each Point Category - Main, delayed accrual, and external trigger based.  **This is…
  - [Get Customer Tier](https://docs.capillarytech.com/reference/lookup-get-customer-tier.md): Retrieves tier details of a customer for a single program or across all programs of the org.  **This is a light API**.
  - [Get Points Conversion Schedule](https://docs.capillarytech.com/reference/lookup-get-points-conversion-schedule.md): Retrieves the history of promised points conversion schedules of a customer for a single program or across all programs of the org.   **This is a light API**.
  - [Lookup Customer Transactions](https://docs.capillarytech.com/reference/get-customers-lookup-transactions.md): Retrieve a list of transactions for a specific customer based on identifiers and filters.
- [Customer Labels](https://docs.capillarytech.com/reference/customer-labels.md): Customer labels are used for tagging customers based on their activities or loyalty histories. Tags are used in loyalty, campaigns and Essential Insights. You can add new labels and tag labels to…
  - [Add Labels](https://docs.capillarytech.com/reference/add-labels.md): Lets you add a new customer tag to the organization. You cannot add tags beyond the limit set for the org.   You can set the label limit at the org level using the API `POST organization/configs` in…
  - [Get All Customer Labels for the Org](https://docs.capillarytech.com/reference/get-org-labels.md): Retrieves all customer labels defined for the organization
  - [Tag Customers (to Labels)](https://docs.capillarytech.com/reference/tag-customers-to-labels.md): Lets you tag a customer to one or more customer labels or remove an existing label.
  - [Get Customer Labels](https://docs.capillarytech.com/reference/get-customer-labels.md): Retrieves the list of labels tagged to a customer.
  - [Search Customers by Label](https://docs.capillarytech.com/reference/search-customers-by-labels.md): Retrieves the list of customers tagged to a specific label. Searches by exact label name, case-insensitive. By default you will see a maximum of 10 records.
- [Transaction (V1)](https://docs.capillarytech.com/reference/transaction.md)
  - [Add Transaction](https://docs.capillarytech.com/reference/add-transaction.md)
  - [Add Transaction with Local Currency](https://docs.capillarytech.com/reference/add-transaction-with-local-currency.md)
  - [Update Transaction Details](https://docs.capillarytech.com/reference/update-transaction-details.md): Lets you update transaction level and transaction line-item level custom fields and extended fields details. It also allows converting a not_interested transaction to a regular transaction (Retro…
  - [Cancel Transaction Lineitem](https://docs.capillarytech.com/reference/cancel-transaction-lineitem.md): Lets you cancel a line-item of a transaction. For example, it can be used for e-commerce platforms where the brand allows a customer to cancel an item (of a transaction) before it is…
  - [Get Transaction Details](https://docs.capillarytech.com/reference/get_transaction_detailsv1.md)
  - [Return Transaction](https://docs.capillarytech.com/reference/return-transaction.md): Lets you submit a return transaction of any transaction type.
  - [Retro Transaction](https://docs.capillarytech.com/reference/retro-transaction.md)
- [Transaction (V2)](https://docs.capillarytech.com/reference/transaction_apis.md)
  - [Add/Return transaction (single)](https://docs.capillarytech.com/reference/add-transaction-single.md): Lets you add a new transaction or return an existing transaction. It supports both loyalty and not-interested transactions.
  - [Add/Return Transaction in Bulk](https://docs.capillarytech.com/reference/addreturn-transaction-bulk.md)
  - [Update Transaction](https://docs.capillarytech.com/reference/update-transaction.md): Lets you update deliveryStatus, custom fields, and extended fields of a transaction. Supports REGULAR, RETURN, NOT_INTERESTED, and NOT_INTERESTED_RETURN transaction types.
  - [Update Transactions in Bulk](https://docs.capillarytech.com/reference/update-transaction-bulk.md): API to update transactions in bulk.
  - [Get Transaction Details With ID](https://docs.capillarytech.com/reference/get-transaction-details.md): Retrieves the details of a specific transaction. Monetary fields in line items may be rounded based on configuration.
  - [Get transaction details using bill number](https://docs.capillarytech.com/reference/retrieve-transaction-details-with-bill-number.md): This API allows you to retrieve transaction details using bill number.
  - [Simulation transaction add](https://docs.capillarytech.com/reference/simulate_transactionadd.md): Lets you perform the simulation of the Transaction Add.
  - [Expose Evaluation log for an event](https://docs.capillarytech.com/reference/expose-evaluation-log-for-an-event.md)
  - [Status codes](https://docs.capillarytech.com/reference/transaction-status-codes.md)
- [getRejectedTransactions](https://docs.capillarytech.com/reference/getrejectedtransactions.md)
- [getReTriggerStatus](https://docs.capillarytech.com/reference/getretriggerstatus.md)
- [markFailed](https://docs.capillarytech.com/reference/markfailed.md)
- [retriggerTransactionAdd](https://docs.capillarytech.com/reference/retriggertransactionadd.md)
- [Coupon (V1.1 APIs)](https://docs.capillarytech.com/reference/coupon-1.md)
  - [Resend Coupon](https://docs.capillarytech.com/reference/resend-coupon.md)
  - [Redeem Coupon](https://docs.capillarytech.com/reference/redeem-coupon.md)
  - [Get Coupon details](https://docs.capillarytech.com/reference/get-coupon-detail.md)
  - [Get Customer Coupons](https://docs.capillarytech.com/reference/get-customer-coupons.md): Retrieves the details of coupons (issued, redeemed, expired) of a specific customer.
  - [Is Coupon Redeemable](https://docs.capillarytech.com/reference/is-coupon-redeemable.md)
  - [Get Coupon series details](https://docs.capillarytech.com/reference/get-coupon-series-details-v1-api.md)
- [Coupon (V2 APIs)](https://docs.capillarytech.com/reference/coupon.md)
  - [Create coupon series](https://docs.capillarytech.com/reference/create-coupon-series.md): Lets you create a new coupon series for the org.
  - [Get coupon series details](https://docs.capillarytech.com/reference/get-coupon-series-details.md)
  - [Issue single coupon](https://docs.capillarytech.com/reference/issue-single-coupon.md)
  - [Issue bulk coupons](https://docs.capillarytech.com/reference/issue-bulk-coupons.md)
  - [Issue multiple coupons to a customer from a series](https://docs.capillarytech.com/reference/issue-bulk-coupon-with-count-from-series.md)
  - [Redeem single coupon](https://docs.capillarytech.com/reference/redeem-single-coupon.md): This API allows you to redeem active coupons of a loyalty customer. You can pass multiple coupons at once.
  - [Redeem bulk coupons](https://docs.capillarytech.com/reference/redeem-bulk-coupons.md): Lets you redeem one or more coupons of a customer.
  - [Check if coupon is Redeemable](https://docs.capillarytech.com/reference/check-if-coupon-is-redeemable.md): Lets you check whether a set of coupons can be redeemed or not.
  - [Reactivate redeemed coupon](https://docs.capillarytech.com/reference/reactivate-redeemed-coupon.md): Reactivates a redeemed coupon. You can pass multiple coupon IDs to reactivate.
  - [Get coupon details](https://docs.capillarytech.com/reference/get-coupon-details.md)
  - [Get All Customer Coupons](https://docs.capillarytech.com/reference/get-customer-coupons-basic.md)
  - [Update coupon redeem field](https://docs.capillarytech.com/reference/update-coupon-redeem-field.md)
  - [Update coupon code expiry date](https://docs.capillarytech.com/reference/update-coupon-code-expiry-date.md)
  - [Revoke coupon](https://docs.capillarytech.com/reference/revoke-coupon.md)
- [Coupon Upload (V1 APIs)](https://docs.capillarytech.com/reference/coupon-upload.md): This resource consists of APIs related to batch coupon operations.
  - [Upload Redeemed Coupons](https://docs.capillarytech.com/reference/upload-redeemed-coupons.md): Lets you upload coupons that are redeemed for a coupon series in bulk.   You can also import coupons (Capillary CRM) that are redeemed externally using an endpoint.
  - [Get Uploaded Coupons' Status](https://docs.capillarytech.com/reference/get-uploaded-coupons-status.md): Retrieves the status of a coupon upload job.
  - [Get Status of Redeemed Coupons](https://docs.capillarytech.com/reference/get-status-of-redeemed-coupons.md): Retrieves the status of the uploaded coupon redeem job a coupon series.
  - [Upload Coupons (Batch)](https://docs.capillarytech.com/reference/upload-coupons-batch.md)
- [Cards](https://docs.capillarytech.com/reference/cards.md)
  - [Add Card Series](https://docs.capillarytech.com/reference/v2addcardseries.md): Endpoint for POST /v2/card/series/
  - [Generate Cards](https://docs.capillarytech.com/reference/generate-cards.md): Lets you generate cards for a card series in bulk.
  - [Get Card Generation Log](https://docs.capillarytech.com/reference/get-card-generation-log.md): Retrieves the log of cards generated under a card series, along with the fileHandle using which you can download the history from S3 server.
  - [Add Card Number to a Card Series](https://docs.capillarytech.com/reference/add-card-number-to-series.md): Lets you add a new card number to a card series and provide card details.  Once the card is added, you can issue it to a customer using customers /changeIdentifier API.
  - [Update Card Details (Single)](https://docs.capillarytech.com/reference/update-card-details-single.md): Lets you update details of a card. You can update details such as card status label, and custom/extended field values.
  - [Update Card Details (Bulk)](https://docs.capillarytech.com/reference/update-card-details-bulk.md): Lets you update details of existing cards in bulk. You can update details such as card status label, and custom/extended field values.
  - [Get Card Details](https://docs.capillarytech.com/reference/get-card-details.md): Retrieves information about a specific card using the card number
  - [Get Status Log](https://docs.capillarytech.com/reference/get-status-log.md): Retrieves the log of status changes of a card number.
  - [Generate Card External ID](https://docs.capillarytech.com/reference/generate-card-external-id.md)
- [Points (v2)](https://docs.capillarytech.com/reference/points-v2-api.md)
  - [Request Goodwill points (Group)](https://docs.capillarytech.com/reference/get-goodwill-request-group.md): Use this API to allocate goodwill points to a user group.
  - [Get Points Conversion Schedule](https://docs.capillarytech.com/reference/get-points-conversion-schedule.md): Retrieves the history of promised points conversion schedules of a customer for a single program or across all programs of the org.This is a light API.
  - [Get Points Balance](https://docs.capillarytech.com/reference/get-points-balance.md): Retrieves points balance of a customer from a single program or all programs of the org. Points are aggregated for each Point Category - Main, delayed accrual, and external trigger based.  **This is…
  - [Get Points Transfer Summary](https://docs.capillarytech.com/reference/get-points-transfer-summary.md): Retrieves points transfer summary of a customer.   This includes points that are transferred from the customer account to another customer’s account (Deduction) and points that are received from…
  - [Get Points Expiry Schedule (Light API)](https://docs.capillarytech.com/reference/get-points-expiry-schedule-light-api.md)
  - [Get Points Expiry Schedule](https://docs.capillarytech.com/reference/get-points-expiry-schedule.md): Retrieves the history of points expired schedules of a customer.
  - [Check Points Transfer Eligibility](https://docs.capillarytech.com/reference/-customer-points-transferrable.md): Checks if specific points of a customer can be transferred to another customer.
  - [Transfer Customer Points](https://docs.capillarytech.com/reference/transfer-points-customer.md): Transfers points from one customer account to another customer account by validating the OTP issued for the points transfer.
  - [Get Points Transfer Details](https://docs.capillarytech.com/reference/get-points-transfer-details.md): Retrieves the history of points transferred from a group or customer.
  - [Redeem customer points](https://docs.capillarytech.com/reference/redeem-customer-points.md): Redeem points from a customer's individual wallet or, when cross-member redemption is enabled, from the combined balance of their UserGroup2 group.
  - [Reverse Redeemed Points](https://docs.capillarytech.com/reference/reverse-redeemed-points.md): Lets you reverse a set of points that are redeemed in a transaction. For example, you can use this API to reverse points redeemed for a transaction if the transaction is returned.
  - [Check Group Points Transfer Eligibility](https://docs.capillarytech.com/reference/group-points-transferrable.md): Checks if specific points from one account can be transferred to another account (group to customer, customer to a group, or one group to another).
  - [Transfer Group Points](https://docs.capillarytech.com/reference/transfer-group-points.md): Lets you transfer points from one account to another account - group to customer, customer to group, or group to group.
  - [Convert Promised Points](https://docs.capillarytech.com/reference/points-unlock-api.md): Convert promised points and alternate currencies to redeemable points.
  - [Update redeem points](https://docs.capillarytech.com/reference/update-redeem-points.md)
  - [Deduct points and alternate currencies from user](https://docs.capillarytech.com/reference/deduct-points-and-alternatecurrencies-from-user.md)
  - [Deduct points and alternate currencies from user using userId](https://docs.capillarytech.com/reference/deduct-points-and-alternatecurrencies-from-user-using-userid.md)
  - [Update Currency Expiry](https://docs.capillarytech.com/reference/update-points-expiry.md): Update expiry dates for points earned by a customer.
  - [Issue points or alternate currencies to customers](https://docs.capillarytech.com/reference/issue-reward-currency.md): This API allows you to manually issue reward currency to a customer or user group.
  - [Get Single Points Expiry Updates](https://docs.capillarytech.com/reference/getsinglepointsexpiryupdates.md): Retrieves points expiry updates for a specific customer.
  - [Get historical points](https://docs.capillarytech.com/reference/get_historical_points.md): Retrieve historical loyalty points activity imported from an external or legacy loyalty program for a specific customer.
  - [Create Historical Points Custom Fields](https://docs.capillarytech.com/reference/historicalpoints-savecustomfields.md)
  - [Get Custom Fields](https://docs.capillarytech.com/reference/historicalpoints-getcustomfields.md): Retrieves custom fields based on the provided field names.
  - [Delete Custom Fields for Historical Points](https://docs.capillarytech.com/reference/historicalpoints-deletecustomfields.md)
- [Points (v1.1)](https://docs.capillarytech.com/reference/points-v11-api.md)
  - [Check If Points Redeemable](https://docs.capillarytech.com/reference/check-if-points-redeemable.md)
  - [Issue Validation Code (to redeem points)](https://docs.capillarytech.com/reference/issue-validation-code.md)
  - [Redeem Points](https://docs.capillarytech.com/reference/redeem-points.md): This API enables you to redeem points of a customer.
- [Points Ledger](https://docs.capillarytech.com/reference/points-ledger.md)
  - [Get Customer Ledger Balance](https://docs.capillarytech.com/reference/get-customer-ledger-balance.md): Retrieves category-wise points’ ledger balance details of a customer for a given time.
  - [Get Points Ledger ](https://docs.capillarytech.com/reference/get-ledger-information.md): Retrieves the points ledger records of a customer, usergroup or alternate currencies for each event.
  - [Get Points Ledger (Lite)](https://docs.capillarytech.com/reference/get-customer-ledger-info-lite.md): Retrieves the points ledger records of a customer or user group without total-count pagination details, returning hasMoreEntries to indicate whether another page exists.
  - [Get Points Ledger Explode Info](https://docs.capillarytech.com/reference/get-points-ledger-explode-info.md): Retrieves the points ledger explode info for customer/ user group.
- [Get Points Ledger Information in Connected Orgs](https://docs.capillarytech.com/reference/connectedorgs-get-customer-ledger-info.md)
- [Get Points Ledger Explode Info in Connected Orgs](https://docs.capillarytech.com/reference/connectedorgs-get-customer-ledger-explode-info.md)
- [Create search filter](https://docs.capillarytech.com/reference/create-meta-search.md): This API allows you to create a search criteria.
- [Retrieve search criteria details](https://docs.capillarytech.com/reference/get-meta.md): This API enables you to retrieve the search criteria details using the search criteria ID obtained during creation of the search criteria.
- [Enable search index of older data](https://docs.capillarytech.com/reference/enable-bulk-trigger.md): This allows you to enable the data retention policy.
- [Perform search](https://docs.capillarytech.com/reference/perform-search.md): You can use this API and search for a transaction/customer data.
- [Deactivate search criteria](https://docs.capillarytech.com/reference/deactivate-search-criteria.md): This API enables you to deactivate a search criteria.
- [Create Data Field](https://docs.capillarytech.com/reference/create-data-field.md): This API allows you to define specific data fields that you want to include in the entity search at organisation level.
- [Update Data Field](https://docs.capillarytech.com/reference/put-data-field-api.md): This API allows you to update data fields that you defined for the org.
- [Get Data Field Detail](https://docs.capillarytech.com/reference/get-data-field-detail-api.md): This API allows you to retrieve the data field definitions for the specified entity (Customer or Transaction)
- [Perform Search (Cortex API)](https://docs.capillarytech.com/reference/search-api-cortex-api.md)
- [Event Transformation for Cortex Search](https://docs.capillarytech.com/reference/event-transformation-using-neo.md)
  - [Use Case](https://docs.capillarytech.com/reference/use-case-1.md)
  - [Quick Start](https://docs.capillarytech.com/reference/quick-start-event-transform-cortex-search.md)
  - [Enable or Update Custom Event Tranformation](https://docs.capillarytech.com/reference/enable-custom-event-for-cortex-search.md)
  - [Retrieve Custom Event Config Details for an Entity](https://docs.capillarytech.com/reference/retrieve-custom-event-config-details-for-entity.md)
  - [Retrieve Custom Event Config Details of Org](https://docs.capillarytech.com/reference/retrieve-custom-event-config-details-of-org.md)
  - [FAQs](https://docs.capillarytech.com/reference/event-tranform-cortex-search-faq.md)
  - [Best Practices](https://docs.capillarytech.com/reference/best-practices-7.md)
- [Badges](https://docs.capillarytech.com/reference/badges.md)
  - [Create badges](https://docs.capillarytech.com/reference/create-badges-org.md)
    - [Fixed Window Restriction in Badges](https://docs.capillarytech.com/reference/fixed-window-use-case.md)
  - [Update badges](https://docs.capillarytech.com/reference/update-badges.md)
  - [Get badge by ID](https://docs.capillarytech.com/reference/get-badge-by-id.md)
  - [Get all badges](https://docs.capillarytech.com/reference/get-all-badges.md)
  - [Get fixed window details](https://docs.capillarytech.com/reference/get-fixed-window-details.md)
  - [Claim badge](https://docs.capillarytech.com/reference/claim-badge.md)
  - [Unclaim badge](https://docs.capillarytech.com/reference/unclaim-badge.md)
  - [Update activation status of badge](https://docs.capillarytech.com/reference/update-the-activation-status-of-badge.md)
  - [Enrol customers for badges](https://docs.capillarytech.com/reference/enrol-customers-for-badges.md)
  - [Issue badge (earn)](https://docs.capillarytech.com/reference/issue-badge-to-the-customer.md)
    - [Multiple Badge Issuances](https://docs.capillarytech.com/reference/multiple-badge-issuances.md)
  - [Issue badge to multiple customers](https://docs.capillarytech.com/reference/issue-badge-to-multiple-customers.md)
  - [Import earned (issued) badges of customer](https://docs.capillarytech.com/reference/import-earned-badges-of-customer.md)
  - [Revoke enrolled badges](https://docs.capillarytech.com/reference/revoke-enrolment-of-a-badge.md)
  - [Revoke issued badge](https://docs.capillarytech.com/reference/revoke-issual-of-a-badge.md)
  - [Get badges for customer](https://docs.capillarytech.com/reference/get-badges-for-customer.md)
  - [Get all customer badges](https://docs.capillarytech.com/reference/get-all-customer-badges.md)
  - [Get individual badge details of a customer](https://docs.capillarytech.com/reference/get-individual-badge-details-of-a-customer.md)
  - [Create badges group](https://docs.capillarytech.com/reference/create-badges-group.md)
  - [Update badges group](https://docs.capillarytech.com/reference/update-badges-group.md)
  - [Get badge group by ID](https://docs.capillarytech.com/reference/get-group-by-id.md)
  - [Get all groups](https://docs.capillarytech.com/reference/get-all-groups.md)
  - [Create custom field for badges](https://docs.capillarytech.com/reference/create-custom-field.md)
  - [Update badge custom field](https://docs.capillarytech.com/reference/update-custom-field-badge.md)
  - [Get badge custom field by ID](https://docs.capillarytech.com/reference/get-custom-field-by-id.md)
  - [Get all badge custom fields](https://docs.capillarytech.com/reference/get-all-custom-fields.md)
- [Rewards Catalog](https://docs.capillarytech.com/reference/rewards-catalog-api.md)
  - [Create Reward](https://docs.capillarytech.com/reference/post-create-reward.md)
  - [Update Reward](https://docs.capillarytech.com/reference/put-update-reward.md)
  - [Get reward details by ID](https://docs.capillarytech.com/reference/get-reward-details-by-id.md)
  - [Adding revenue metadata against a reward](https://docs.capillarytech.com/reference/adding-revenue-metadata-against-a-reward.md)
  - [Create Reward Category](https://docs.capillarytech.com/reference/create-reward-category.md): Create a new reward category.
  - [Enable or Disable Reward Categories](https://docs.capillarytech.com/reference/enable-or-disable-reward-categories.md): Enable or disable a particular reward category.
  - [Get Reward Category](https://docs.capillarytech.com/reference/get-reward-category.md): Get reward categories for a particluar brand.
  - [Create Rich Text Content Metadata for Rewards](https://docs.capillarytech.com/reference/create-rich-content-meta.md)
  - [Update Rich Text Content Metadata for Rewards](https://docs.capillarytech.com/reference/update-rich-content.md)
  - [Get all Rich Text Content Metadata for specific brand](https://docs.capillarytech.com/reference/get-all-rich-text-content-metadata-for-brand.md): This API is used to fetch rich content metadata for rewards within a brand.
  - [Adding Rich Text Content field for Reward](https://docs.capillarytech.com/reference/adding-rich-text-content-metadata.md)
  - [Issue single reward](https://docs.capillarytech.com/reference/post-issue-user-reward.md)
  - [Reward Issuance with Quantity and Redemption Value Details](https://docs.capillarytech.com/reference/reward-issuance-with-quantity-and-calculation-scenarios.md)
  - [Issue bulk reward](https://docs.capillarytech.com/reference/issue-bulk-reward.md)
  - [Idempotency Check for Issuing Reward](https://docs.capillarytech.com/reference/idempotency-check-for-issuing-reward.md)
  - [Reward State Management](https://docs.capillarytech.com/reference/reward-state-management.md)
    - [Redeem User Reward](https://docs.capillarytech.com/reference/redeem-user-reward.md)
    - [Reverse-Redeem User Reward](https://docs.capillarytech.com/reference/reverse-redeem-user-reward.md)
    - [Revoke User Reward](https://docs.capillarytech.com/reference/revoke-user-reward.md)
    - [Update User Reward Expiry](https://docs.capillarytech.com/reference/update-expiry-user-reward.md)
  - [Get rewards for user](https://docs.capillarytech.com/reference/get-rewards-for-user.md)
  - [Get customer reward transactions](https://docs.capillarytech.com/reference/get-all-reward-transactions-for-a-user.md)
  - [Get Reward Transaction Details using Reward Transaction ID](https://docs.capillarytech.com/reference/get-transaction-details-by-reward-transaction-id.md)
  - [Get Purchased Rewards for User ](https://docs.capillarytech.com/reference/get-rewards-for-user-new-api.md)
  - [Get available reward details for user by id](https://docs.capillarytech.com/reference/get-user-brand-specific-rewards.md)
  - [Get all brand rewards using Brand ID](https://docs.capillarytech.com/reference/get-reward-list.md)
  - [Get Brand Rewards](https://docs.capillarytech.com/reference/get-brands-rewards.md)
  - [Get available brand rewards](https://docs.capillarytech.com/reference/get-available-brand-rewards.md)
  - [Get Transaction Details by Customer ID and Reward Transaction ID](https://docs.capillarytech.com/reference/get-reward-issue-transaction-details.md)
  - [Create catalog promotion](https://docs.capillarytech.com/reference/post-create-catalog-promotion.md)
  - [Update catalog promotion](https://docs.capillarytech.com/reference/put-update-catalog-promotion.md)
  - [Get catalog promotion details](https://docs.capillarytech.com/reference/get-catalog-promotion-details.md)
  - [Get list of Catalog promotions](https://docs.capillarytech.com/reference/get-list-of-catalog-promotions.md)
  - [Disable Catalog promotion](https://docs.capillarytech.com/reference/put-disable-catalog-promotion.md)
  - [Create custom field for reward](https://docs.capillarytech.com/reference/post-create-custom-field.md)
  - [Update reward custom field](https://docs.capillarytech.com/reference/update-custom-field.md)
  - [Get all custom fields](https://docs.capillarytech.com/reference/get-custom-field.md)
  - [Groups - Create reward group](https://docs.capillarytech.com/reference/create-group-reward.md)
  - [Groups - Update rewards group](https://docs.capillarytech.com/reference/update-group-reward.md)
  - [Groups - Get all rewards group](https://docs.capillarytech.com/reference/get-group-rewards.md)
  - [Groups - Get rewards group by ID](https://docs.capillarytech.com/reference/get-rewards-group-by-id.md)
  - [Points Restrictions - Create points restriction](https://docs.capillarytech.com/reference/create-points-restriction.md)
  - [Points - Update points restriction](https://docs.capillarytech.com/reference/update-points-restriction.md)
  - [Points - Get points constraints](https://docs.capillarytech.com/reference/get-points-constraints.md)
  - [Organisation Level Configuration for Rewards Catalog](https://docs.capillarytech.com/reference/organisation-level-configuration-for-rewards-catalog.md)
  - [Get Organisation Level Configuration](https://docs.capillarytech.com/reference/retrieve-organisation-level-configuration-for-rewards-catalog.md)
  - [Create a Vendor](https://docs.capillarytech.com/reference/createvendor.md)
  - [Update Vendor Metadata](https://docs.capillarytech.com/reference/update-vendor-metadata.md): Endpoint for PUT /api_gateway/rewards/core/v1/vendor/119
  - [Enable or Disable a Vendor](https://docs.capillarytech.com/reference/enable-disable-vendor.md)
  - [Get Vendor Details](https://docs.capillarytech.com/reference/get-vendor-explode-info.md)
  - [Vendor List for Specific Brand](https://docs.capillarytech.com/reference/get-vendor-list-for-specific-brand.md)
  - [Update Vendor Redemption](https://docs.capillarytech.com/reference/update-vendor-redemption.md): Update Vendor Redemption API enables a brand to modify an existing vendor redemption configuration with updated details. A vendor redemption can also be updated for disabled vendors.
  - [Get all vendor redemptions](https://docs.capillarytech.com/reference/get-vendor-redemptions-details.md)
  - [Vendor Redemption Details by Redemption & Vendor ID](https://docs.capillarytech.com/reference/get-list-of-vendor-redemption-details-by-vendor-id.md)
  - [Vendor Redemption Details by Brand ID and Vendor ID](https://docs.capillarytech.com/reference/get-vendor-redemption-details-by-brand-id-and-vendor-id.md)
  - [Upload images to file service](https://docs.capillarytech.com/reference/post-images-to-file-service.md)
  - [Create fulfillment status](https://docs.capillarytech.com/reference/create-fulfillment-status.md)
  - [Update fulfillment status](https://docs.capillarytech.com/reference/update-fulfillment-status.md)
  - [Get fulfillment status](https://docs.capillarytech.com/reference/get-fulfillment-status.md)
  - [Update fulfillment status and transaction custom fields for issued rewards](https://docs.capillarytech.com/reference/update-fulfilment-status-and-txn-custom-fields.md)
  - [Create Reward Expiry Reminder](https://docs.capillarytech.com/reference/create-reward-expiry-reminder.md)
  - [Update Reward Expiry Reminder](https://docs.capillarytech.com/reference/update-reward-expiry-reminder.md)
  - [Get Reward Expiry Reminder](https://docs.capillarytech.com/reference/get-reward-expiry-reminder.md)
  - [Issue Reward in connected orgs](https://docs.capillarytech.com/reference/issue-bulk-reward-connected-org.md)
  - [Get all available rewards for user in connected orgs](https://docs.capillarytech.com/reference/get-all-available-rewards-for-user-in-a-connected-org.md)
  - [Get all reward transactions for a user in connected orgs](https://docs.capillarytech.com/reference/get-all-reward-transactions-for-a-user-in-connected-orgs.md): This API is used to retrieve reward transactions for a user using filters.
  - [Get Transaction Details by Reward Transaction ID in Connected orgs](https://docs.capillarytech.com/reference/get-transaction-details-by-reward-transaction-id-in-connected-orgs.md): This API is used to retrieve details of a specific reward transaction using reward transaction ID, in connected orgs.
  - [Get Purchased Rewards for User in Connected Orgs](https://docs.capillarytech.com/reference/get-purchased-rewards-for-user-connected-org.md)
  - [Get reward details by ID in connected orgs](https://docs.capillarytech.com/reference/get-reward-details-by-id-in-a-connected-org.md)
  - [Language ](https://docs.capillarytech.com/reference/language.md)
    - [Create Language Metadata for Rewards](https://docs.capillarytech.com/reference/create_language_metadata.md): Endpoint for POST /api_gateway/rewards/core/v1/metadata/language/create
    - [Get All Language Metadata](https://docs.capillarytech.com/reference/get_all_languages.md): Endpoint for POST /api_gateway/rewards/core/v1/metadata/languages
    - [Enable Language for Rewards](https://docs.capillarytech.com/reference/enable_disable_languagemetadata.md): This API allows you to enable the language metadata for rewards for your organization.
    - [Disable Language for Rewards ](https://docs.capillarytech.com/reference/putapi_gatewayrewardscorev1metadatalanguage12statusdisable.md): This API allows you to disable the language metadata for rewards for your organization.
- [Target/Milestone](https://docs.capillarytech.com/reference/target-milestones.md)
  - [Milestone & Streaks APIs](https://docs.capillarytech.com/reference/target-group-1.md)
  - [User-Created Challenges](https://docs.capillarytech.com/reference/user-created-challenges.md)
  - [Connected Org APIs](https://docs.capillarytech.com/reference/connected-org-apis.md)
    - [Enroll/Re-Enroll a Customer to a Milestone or Streak](https://docs.capillarytech.com/reference/connectedorgs-enroll-customer-milestone-or-streak.md)
    - [Unenroll a Customer to from Milestone or Streak](https://docs.capillarytech.com/reference/connectedorgs-unenroll-customer-milestone-or-streak.md)
    - [Get Associated Target Groups of a User](https://docs.capillarytech.com/reference/connectedorgs-get-associated-target-groups-of-a-user.md)
    - [Data Scopes](https://docs.capillarytech.com/reference/connected-orgs-data-scopes.md)
  - [Leaderboards](https://docs.capillarytech.com/reference/leaderboards.md)
    - [Get top ranked users](https://docs.capillarytech.com/reference/get-top-ranked-users.md)
    - [Get user rank across target groups](https://docs.capillarytech.com/reference/get-user-ranks-across-target-groups.md)
- [Tiers](https://docs.capillarytech.com/reference/tiers.md)
  - [Create Tier](https://docs.capillarytech.com/reference/create-tier.md): Create a new tier in DRAFT status for a loyalty program.
  - [List All Tiers](https://docs.capillarytech.com/reference/list-all-tiers.md): Retrieve all tiers of a loyalty program.
  - [Get Tier](https://docs.capillarytech.com/reference/get-tier.md): Retrieve the details of a single tier by ID.
  - [Update Tier](https://docs.capillarytech.com/reference/update-tier.md): Update a tier by its record ID or numeric slab ID.
  - [Delete Tier](https://docs.capillarytech.com/reference/delete-tier.md): Soft-delete a DRAFT tier.
  - [Submit Tier for Approval](https://docs.capillarytech.com/reference/submit-tier-for-approval.md): Submit a DRAFT tier for maker-checker approval.
  - [Approve or Reject Tier](https://docs.capillarytech.com/reference/approve-or-reject-tier.md): Approve or reject a tier that is pending approval.
  - [List Pending Tier Approvals](https://docs.capillarytech.com/reference/list-pending-tier-approvals.md): Retrieve all tiers pending approval for a program.
- [Subscriptions](https://docs.capillarytech.com/reference/subscriptions.md)
  - [Create Subscription](https://docs.capillarytech.com/reference/post_v3-subscriptions.md): Create a new subscription program in DRAFT status.
  - [List All Subscriptions](https://docs.capillarytech.com/reference/get_v3-subscriptions.md): List subscription programs for a loyalty program, with pagination.
  - [Get Subscription](https://docs.capillarytech.com/reference/get_v3-subscriptions-id.md): Retrieve a subscription program by ID and status.
  - [Update Subscription](https://docs.capillarytech.com/reference/put_v3-subscriptions-id.md): Update an existing subscription program.
  - [Discard Subscription](https://docs.capillarytech.com/reference/delete_v3-subscriptions-id.md): Permanently deletes a DRAFT subscription program.
  - [Update Subscription Status](https://docs.capillarytech.com/reference/patch_v3-subscriptions-id-status.md): Moves a subscription program through its approval, pause, and stop workflow.
  - [Approve Subscription](https://docs.capillarytech.com/reference/post_v3-subscriptions-id-approve.md): Approves or rejects a subscription program that is PENDING_APPROVAL.
  - [Link Benefit to Subscription](https://docs.capillarytech.com/reference/post_v3-subscriptions-id-benefits-benefitid.md): Attaches a benefit to a subscription program by numeric benefit ID.
  - [Unlink Benefit from Subscription](https://docs.capillarytech.com/reference/delete_v3-subscriptions-id-benefits-benefitid.md): Removes a benefit from a subscription program by numeric benefit ID.
  - [Pause Subscription](https://docs.capillarytech.com/reference/pause-subscription.md): Pauses a customer's active subscription (supplementary partner program) for a fixed date range.
  - [Resume Subscription](https://docs.capillarytech.com/reference/resume-subscription.md): Resumes a customer's paused subscription (supplementary partner program).
- [Loyalty Config Attributes](https://docs.capillarytech.com/reference/loyalty-config-attributes.md)
  - [Create Loyalty Config Attribute](https://docs.capillarytech.com/reference/post_v3-loyaltyconfigattributes-config.md): Defines a new config attribute for a program under a specific scope.
  - [List All Loyalty Config Attributes](https://docs.capillarytech.com/reference/get_v3-loyaltyconfigattributes-config.md): Returns a paginated list of config attributes for a program.
  - [Update Loyalty Config Attribute](https://docs.capillarytech.com/reference/put_v3-loyaltyconfigattributes-config-id.md): Activates or deactivates a config attribute. No other field can be changed after creation.
  - [List Loyalty Config Attribute Scopes](https://docs.capillarytech.com/reference/get_v3-loyaltyconfigattributes-scopes.md): Returns every scope available for defining config attributes.
- [Benefits](https://docs.capillarytech.com/reference/benefits.md)
  - [Create Benefit](https://docs.capillarytech.com/reference/create-benefit.md): Create a new loyalty benefit in DRAFT status.
  - [Submit Benefit for Approval](https://docs.capillarytech.com/reference/submit-benefit-for-approval.md): Submit a DRAFT benefit for approval.
  - [Approve or Reject Benefit](https://docs.capillarytech.com/reference/approve-or-reject-benefit.md): Approve or reject a benefit that is pending approval.
  - [Manage Benefit Status](https://docs.capillarytech.com/reference/manage-benefit-status.md): Pause, resume, stop, or revoke a benefit.
  - [Update Benefit](https://docs.capillarytech.com/reference/update-benefit.md): Update an existing loyalty benefit.
  - [Duplicate Benefit](https://docs.capillarytech.com/reference/duplicate-benefit.md): Duplicate an existing benefit as a new DRAFT.
  - [Get Benefit](https://docs.capillarytech.com/reference/get-benefit.md): Retrieve a single loyalty benefit by ID.
  - [List All Benefits](https://docs.capillarytech.com/reference/list-all-benefits.md): Retrieve a paginated list of loyalty benefits for a program.
- [Benefit Categories](https://docs.capillarytech.com/reference/benefit-categories.md)
  - [Create Benefit Category](https://docs.capillarytech.com/reference/create-benefit-category.md): Creates a benefit category for a loyalty program.
  - [List All Benefit Categories](https://docs.capillarytech.com/reference/list-all-benefit-categories.md): Retrieves a paginated list of benefit categories.
  - [Get Benefit Category](https://docs.capillarytech.com/reference/get-benefit-category.md): Retrieves the details of a single benefit category by its id.
  - [Update Benefit Category](https://docs.capillarytech.com/reference/update-benefit-category.md): Updates a benefit category, identified by its id.
  - [Activate Benefit Category](https://docs.capillarytech.com/reference/activate-benefit-category.md): Activates a benefit category, identified by its id.
  - [Deactivate Benefit Category](https://docs.capillarytech.com/reference/deactivate-benefit-category.md): Deactivates a benefit category, identified by its id. Automatically unlinks any benefits that reference it.
- [Loyalty Promotions](https://docs.capillarytech.com/reference/loyalty-promotions.md)
  - [Create a Loyalty Promotion](https://docs.capillarytech.com/reference/create-a-loyalty-promotion.md): Endpoint for POST /v3/promotions
  - [Update Promotion Status](https://docs.capillarytech.com/reference/submit-promotion-for-approval.md): Updates the status of a loyalty promotion to manage its lifecycle. Supports submitting a promotion for approval, withdrawing it from review, pausing or resuming an active promotion, and stopping a…
  - [Review a Loyalty Promotion](https://docs.capillarytech.com/reference/review-loyalty-promotion.md): Endpoint for POST /v3/promotions/69034fe43d40cd1e08fb66d8/review
  - [Enrol Members to a Loyalty Promotion](https://docs.capillarytech.com/reference/enrol-loyalty-promotion.md): Endpoint for POST /v3/promotions/enrol
  - [Update a Loyalty Promotion](https://docs.capillarytech.com/reference/update-loyalty-promotion.md): Endpoint for PUT /api_gateway/v1/promotions/%7Bpromotion_id%7D
  - [Discard a Loyalty Promotion Draft](https://docs.capillarytech.com/reference/discard-loyalty-promotion-draft.md): Permanently deletes the pending draft on a published loyalty promotion, restoring a clean edit surface without affecting the running promotion.
  - [Get Details of Loyalty Promotion using ID](https://docs.capillarytech.com/reference/get-loyalty-promotion-id.md): Endpoint for GET /v3/promotions/6903253184daf5486232dec9
  - [Get Details of all Loyalty Promotions](https://docs.capillarytech.com/reference/get-loyalty-promotion-all.md): Endpoint for GET /v3/promotions
  - [List All Promotion Ranks](https://docs.capillarytech.com/reference/get-promotion-ranks.md): Retrieves the ranked list of published promotions for a loyalty program, along with each promotion's stacking configuration and reward types.
  - [List Member Promotions](https://docs.capillarytech.com/reference/list-member-promotions.md)
  - [Get Member Promotion Explode Details](https://docs.capillarytech.com/reference/list-member-promotions-explode.md)
  - [Get Customer Promotion Details](https://docs.capillarytech.com/reference/get-customer-promotion-details.md)
  - [Revoke a Loyalty Promotion](https://docs.capillarytech.com/reference/revoke-a-loyalty-promotion.md): Revokes a customer's enrollment or opt-in from a v3 unified loyalty promotion.
- [Cart Promotions](https://docs.capillarytech.com/reference/loyalty-cart-promotions.md)
  - [Create Cart Promotions](https://docs.capillarytech.com/reference/create-cart-promotion-api.md)
  - [Update Cart Promotion](https://docs.capillarytech.com/reference/update-cart-promotion-details_.md)
  - [Issue Cart Promotion](https://docs.capillarytech.com/reference/issue-cart-promotion.md): Issue Cart Promotion for the customer.
  - [Get Cart Promotion Redemptions](https://docs.capillarytech.com/reference/get-cart-promotion-redemptions.md): Retrieves all promotion redemptions.
  - [Activate Promotion for Customer](https://docs.capillarytech.com/reference/post_api-gateway-v1-promotions-promotionid-activate.md)
  - [Activate Cart Promotion](https://docs.capillarytech.com/reference/activate-global-promotions.md)
  - [Get Cart Promotion Details using Code & Promotion mode](https://docs.capillarytech.com/reference/get-promotions-code-api.md): This API can be used to fetch the Cart promotion details based on the code of the promotion
  - [Deactivate Cart Promotion for Customer](https://docs.capillarytech.com/reference/post_api-gateway-v1-promotions-promotionid-deactivate.md)
  - [Deactivate Cart Promotion](https://docs.capillarytech.com/reference/deactivate-global-promotion.md)
  - [Get Cart Promotions for a particular till](https://docs.capillarytech.com/reference/get-promotions-for-a-particular-till.md): This API can be used to fetch the cart promotions for a particular till.
  - [Get Pending Carts Details (Cart Promotion)](https://docs.capillarytech.com/reference/get-lock-unlock-pending-carts.md): This API evaluates and returns the details of the carts which are pending  for a particular customer(cart promotions have been applied but transaction not completed yet)
  - [Get Cart Promotions Configurations Using Promotion ID](https://docs.capillarytech.com/reference/get-promotions-config-api.md): This API can be used fetch the configurations of the cart promotions via promotion ids
  - [Get Cart Promotions available for a Customer](https://docs.capillarytech.com/reference/get-promotions-for-a-customer.md): This API is used to retrieve the cart promotions tagged to a particular customer based on the user ID. This returns cart promotions issued to the customer or POS promotions which are tagged to the…
  - [Earn Cart Promotion](https://docs.capillarytech.com/reference/earn-promotion.md): Description :With this API , we can get the details of all the cart promotions earned by a particular customer.
  - [Revoke Earned Cart Promotion](https://docs.capillarytech.com/reference/revoke-earned-promotion.md): This API is used to revoke an already earned cart promotion
  - [Revoke Cart Promotion](https://docs.capillarytech.com/reference/revoke-cart-promotion.md)
  - [Earn Cart Promotions in Bulk](https://docs.capillarytech.com/reference/post-earn-promotions-in-bulk.md): This API is used to earn cart promotions in bulk to the customers
  - [Evaluate Promotions](https://docs.capillarytech.com/reference/post_api-gateway-v1-promotions-evaluate.md)
  - [Cancel Cart Evaluation - Cart Promotion](https://docs.capillarytech.com/reference/post-cancel-cart-evaluation.md): This API is used to cancel pending carts where a promotion is locked.
  - [Link Cart Promotion Code to the Customer ID](https://docs.capillarytech.com/reference/post-promotions-code-link-api.md): This API is used to link the code of the cart promotion earned by the customer to the customer id.
  - [Redeem Cart Promotion](https://docs.capillarytech.com/reference/redeem-cart-promotion.md): This API records a customer's cart promotion redemption during a transaction.
  - [Get Customer Accumulation Status](https://docs.capillarytech.com/reference/post-accumulation-tracker-api.md)
- [Add User Group](https://docs.capillarytech.com/reference/add-group.md): Lets you create a new user group. Groups you create will be added to the default loyalty program of the org automatically.
- [Update User Group](https://docs.capillarytech.com/reference/update-user-group.md): Lets you update an existing user group details.
- [Deduct Points and Alternate Currencies from user group](https://docs.capillarytech.com/reference/deduct-points-and-alternatecurrencies-from-user-group.md)
- [Search user groups by name, ID, and mobile number](https://docs.capillarytech.com/reference/get-user-group-details.md): Retrieves the details of a specific group using the unique ID or external ID of the group.
- [Delete User Group](https://docs.capillarytech.com/reference/delete-user-group.md): This API allows you to delete an user group.
- [Join Member to Group](https://docs.capillarytech.com/reference/join-member-to-group.md): This API allows you to add a member to a group.
- [Remove group member](https://docs.capillarytech.com/reference/remove-group-member.md): Removes a group member.
- [Transfer Group Member](https://docs.capillarytech.com/reference/transfer-group-member.md): Lets you transfer members from one group to another.
- [Transfer Primary Member](https://docs.capillarytech.com/reference/transfer-primary-member.md): Transfers the primary member (group owner) tag to another active member of the same group.
- [Get group transactions](https://docs.capillarytech.com/reference/get-group-transactions.md): Retrieves the transactions of a specific group. You can also get transactions of a group member using query parameters.
- [Retrieve user group members list](https://docs.capillarytech.com/reference/retrieve-user-group-member-details.md): This API allows you to retrieve details of members in the user group.
- [Retrieve user group member details](https://docs.capillarytech.com/reference/retrieve-primary-secondary-member-details.md): Retrieves details of all members in a user group, including their roles, identifiers, permissions, and points contributed. Optionally returns card details, customer status information, and pagination.
- [Retrieve group slab/tier log history](https://docs.capillarytech.com/reference/retrieve-group-tier-log-history.md): This API enables you to retrieve group's tier log history.
- [Retrieve points expiry schedule of a group](https://docs.capillarytech.com/reference/get-points-expiry-schedule-of-a-group.md): This API allows you to retrieve the points expiry schedule of a specific group.
- [Retrieve points conversion schedule](https://docs.capillarytech.com/reference/retrieve-points-conversion-schedule.md): This API lets you retrieve points conversion schedule of a group.
- [Status codes](https://docs.capillarytech.com/reference/user-group-status-codes.md)
- [Update permissions](https://docs.capillarytech.com/reference/update-user-group-permission.md): API to update permissions of a member in a group.
- [Update Default Group](https://docs.capillarytech.com/reference/update-default-group-of-a-member.md): API to set, move, or clear the default group of a user group member.
- [Search for groups using the extended fields](https://docs.capillarytech.com/reference/search-for-groups-using-the-extended-fields.md): Search for groups based on the extended fields associated with them.
- [Get group points ledger](https://docs.capillarytech.com/reference/get-group-points-ledger.md): Retrieve a paginated history of group point redemptions and reversals for a group or for a specific member within their group.
- [Organization (V1)](https://docs.capillarytech.com/reference/organization.md): The organization entity holds configuration details and transaction details of an organization. You to retrieve the org level details such as profile information, configurations set on InTouch,…
  - [Get Org Details](https://docs.capillarytech.com/reference/get-org-details.md): Retrieves the details of the organization provided during the org setup on InTouch. Details such as org id, name, address, base language, base currency, time zone, website address and so on will be…
  - [Get Org Entities](https://docs.capillarytech.com/reference/get-org-entities.md): Retrieves the details of zones, stores, store servers, concepts or TILLs configured for the current organization. By default, it fetches up to 200 entities.
  - [Get Org Configurations](https://docs.capillarytech.com/reference/get-org-configurations.md): Returns the organization configuration details in key and value pairs.
  - [Get Org Statistics](https://docs.capillarytech.com/reference/get-org-statistics.md): Returns the statistical information of the org which contains count of stores, zones, tills, loyalty customers, and products sold; average transaction amount, basket size and so on.
  - [Get Org Custom Fields](https://docs.capillarytech.com/reference/get-org-custom-fields-1.md): Returns the details of custom fields configured for the current organization.
  - [Retrieve Brand ID](https://docs.capillarytech.com/reference/retrieve-brand-id.md)
  - [Get Org Payment Modes](https://docs.capillarytech.com/reference/get-org-payment-modes.md): Returns the details of payment modes configured for your organization.
- [Organization (V2)](https://docs.capillarytech.com/reference/organization-api.md): This entity consist of the list of APIs related to adding and fetching sources and accounts of the org.
  - [Set Organisation Configuration](https://docs.capillarytech.com/reference/limit-active-cards-per-customer.md): Use this API to set organisation configuration values. Specify a configuration key, its value, and the scope at which it applies.
  - [Get Custom Fields](https://docs.capillarytech.com/reference/get-org-custom-fields.md): Retrieves all the custom fields created for the org.
  - [Get Config Key Values](https://docs.capillarytech.com/reference/get-organization-configs.md): Retrieves the organization configuration values based on config name.
  - [Get org till details](https://docs.capillarytech.com/reference/get-tills.md): Retrieves the details of a specific till based on the Till code or till ID passed.
  - [Get Active Tills](https://docs.capillarytech.com/reference/get-active-tills.md): Retrieves the details of a specific ill based on the Till code or till ID passed.
  - [Get Loyalty Programs](https://docs.capillarytech.com/reference/get-loyalty-programs.md): Retrieves all the active loyalty programs of the org.
  - [Retrieve org hierarchy details](https://docs.capillarytech.com/reference/retrieve-org-hierarchy-details.md): API to retrieve hierarchy details of an org.
  - [Get Till ID Details](https://docs.capillarytech.com/reference/get-till-id-details.md)
- [Product APIs (v2)](https://docs.capillarytech.com/reference/product-v2-apis.md)
  - [Add Brands ](https://docs.capillarytech.com/reference/post_v2-product-brands.md): Creates new product brands or updates existing ones in bulk.
  - [Update Brands ](https://docs.capillarytech.com/reference/put_v2-product-brands.md)
  - [Get/Search Brands](https://docs.capillarytech.com/reference/get_v2-product-brands.md)
  - [Add Categories](https://docs.capillarytech.com/reference/post_v2-product-categories.md): Creates new product categories in bulk.  **Code uniqueness:** Category codes are validated case-insensitively. For example, "CATEGORY1" and "category1" are treated as duplicates. The same code can…
  - [Update Categories ](https://docs.capillarytech.com/reference/put_v2-product-categories.md)
  - [Get/Search Categories ](https://docs.capillarytech.com/reference/get_v2-product-categories.md)
  - [Add Attributes ](https://docs.capillarytech.com/reference/add_product_attributes_v2.md): Endpoint for POST /v2/product/attributes
  - [Update Attributes ](https://docs.capillarytech.com/reference/put_v2-product-attributes.md)
  - [Get/Search Attributes ](https://docs.capillarytech.com/reference/get_v2-product-attributes.md)
  - [Add Attribute Values](https://docs.capillarytech.com/reference/add_product_attribute_values_v2.md)
  - [Update Attribute Values](https://docs.capillarytech.com/reference/put_v2-product-attributevalues.md)
  - [Get/Search Attribute Values ](https://docs.capillarytech.com/reference/get_v2-product-attributes-attributeid-values.md)
  - [Add SKUs ](https://docs.capillarytech.com/reference/post_v2-product-skus.md): Create new product SKUs or update existing ones in bulk.
  - [Update SKUs](https://docs.capillarytech.com/reference/put_v2-product-skus.md): Updates existing product SKUs with the provided details.
  - [Get/Search Product SKUs ](https://docs.capillarytech.com/reference/get_v2-product-skus.md)
- [Product (v1)](https://docs.capillarytech.com/reference/v1-apis.md)
  - [Add Product](https://docs.capillarytech.com/reference/add-product.md): Allows you to add product to the inventory.
  - [Get Product Attributes](https://docs.capillarytech.com/reference/get-product-attributes.md): Retrieves the list of all product attributes of the org.   Some attributes like price, item_sku, description, img_url would be common across organizations.
  - [Get Product Brands](https://docs.capillarytech.com/reference/get-product-brands.md): Retrieves the details of all product brands created for the org.
  - [Get Product Categories](https://docs.capillarytech.com/reference/get-product-categories.md): Retrieves the details of all product categories.
  - [Get Product Colors](https://docs.capillarytech.com/reference/get-product-colors.md): Retrieves the details of all product colors configured for the org.
  - [Get Product Details](https://docs.capillarytech.com/reference/get-product-details.md): Returns the details of a specific product. You can retrieve details of multiple products at a time.
  - [Get Product Meta Sizes](https://docs.capillarytech.com/reference/get-product-meta-sizes.md): Retrieves details of all product meta-sizes.
  - [Get Product Sizes](https://docs.capillarytech.com/reference/get-product-sizes.md): Retrieves the list of all configured product sizes.
  - [Search Products](https://docs.capillarytech.com/reference/search-products.md): Retrieve products available at the current org based on the query params such as SKU, quantity, price, item status, images, attributes and so on.
  - [Response codes](https://docs.capillarytech.com/reference/response-codes-1.md): This page lists the response codes related to the Product APIs.
- [Labels](https://docs.capillarytech.com/reference/labels.md)
  - [Create Labels](https://docs.capillarytech.com/reference/create-labels.md)
  - [Update labels](https://docs.capillarytech.com/reference/update-labels.md)
  - [Get/Search labels](https://docs.capillarytech.com/reference/get-labels.md)
  - [Create label assignments](https://docs.capillarytech.com/reference/create-label-assignments.md)
  - [Update label assignments](https://docs.capillarytech.com/reference/update-label-assignments.md)
  - [Get label assignments](https://docs.capillarytech.com/reference/get-label-assignments.md)
  - [Search Label Assignments](https://docs.capillarytech.com/reference/search-label-assignments.md)
  - [Remove label assignments](https://docs.capillarytech.com/reference/remove-label-assignments.md)
- [Location APIs (v1)](https://docs.capillarytech.com/reference/location-apis-v1.md)
  - [Add Store](https://docs.capillarytech.com/reference/add-store.md): Allows org admins to add a store to an org.
  - [Add Store in bulk](https://docs.capillarytech.com/reference/add-store-in-bulk.md): Allows the org admin to add stores in bulk
  - [Update Bulk Stores](https://docs.capillarytech.com/reference/put_v2-orgentity-store-bulk.md): Allows the org admin to update existing stores in bulk
  - [Get Store Configurations](https://docs.capillarytech.com/reference/get-store-configurations.md): Returns InStore configuration details of a specific store.
  - [Get Store Details](https://docs.capillarytech.com/reference/get-store-details.md): Returns all the details of a store based on the store's `id` or `external_id` passed.
  - [Get Store Reports](https://docs.capillarytech.com/reference/get-store-reports.md): Returns report of a specific store containing details like sales of previous day, week and month; customers visited; points and coupons issued; points and coupons redeemed etc will be returned. The…
  - [Get Store Staff Details](https://docs.capillarytech.com/reference/get-store-staff-details.md): Returns the entire staff details of the current organization. Staff could be associates or managers.
  - [Get Store Tasks](https://docs.capillarytech.com/reference/get-store-tasks.md): Returns the details of store tasks such as task title, description, status, and updates.
  - [Upload Store Reports](https://docs.capillarytech.com/reference/upload-store-reports.md): Uploads store report from InStore to the main server.
  - [Verify Login Credentials](https://docs.capillarytech.com/reference/verify-login-credentials.md): Verifies whether the provided login credentials are valid and if valid, returns the details of current logged in user.
  - [Upload Store Logs](https://docs.capillarytech.com/reference/upload-store-logs.md): Uploads the log files of InStore as per the headers provided - supports activity logs and performance logs.
- [Location APIs (v2)](https://docs.capillarytech.com/reference/location-apis-v2.md)
  - [Add Zones in Bulk](https://docs.capillarytech.com/reference/add-zones-in-bulk.md): Create up to 100 zones in a single request.
  - [Update Zones in Bulk](https://docs.capillarytech.com/reference/update-zones-in-bulk.md): Update up to 100 zones in a single request.
  - [Add Stores in Bulk](https://docs.capillarytech.com/reference/add-stores-in-bulk.md): Create up to 100 stores in a single request.
  - [Update Stores in Bulk](https://docs.capillarytech.com/reference/update-stores-in-bulk.md): Update up to 100 stores in a single request.
  - [Add Tills in Bulk](https://docs.capillarytech.com/reference/add-tills-in-bulk.md): Create up to 50 tills in a single request.
  - [Update Tills in Bulk](https://docs.capillarytech.com/reference/update-tills-in-bulk.md): Update up to 50 tills in a single request.
  - [Add Concepts in Bulk](https://docs.capillarytech.com/reference/add-concepts-in-bulk.md): Create up to 100 concepts in a single request.
  - [Update Concepts in Bulk](https://docs.capillarytech.com/reference/update-concepts-in-bulk.md): Update up to 100 concepts in a single request.
  - [Get Locations](https://docs.capillarytech.com/reference/get-locations.md): Search and filter stores, zones, tills, and concepts in your org by type, code, name, or external ID.
- [Store Locator API](https://docs.capillarytech.com/reference/store-locator-api.md)
  - [Overview](https://docs.capillarytech.com/reference/overview.md)
  - [Authentication Token](https://docs.capillarytech.com/reference/generateauthtoken.md)
  - [Locate nearby stores](https://docs.capillarytech.com/reference/getstorelocatorv1brandnearbystores.md): This endpoint retrieves a paginated list of stores near a given location, with optional filters for site status and actual distance calculation.
  - [Retrieve Organization Sync Data](https://docs.capillarytech.com/reference/getintegrationv1syncorg7borgid7d.md): Endpoint for GET /integration/v1/sync/org/%7BorgId%7D
  - [Store Locator Custom Fields](https://docs.capillarytech.com/reference/postintegrationv1brand7bbrandid7dstorelocatorcustomfieldsmap.md): Endpoint for POST /integration/v1/brand/%7BbrandId%7D/store-locator/custom-fields/map
  - [Retrieve Mapped Custom Field](https://docs.capillarytech.com/reference/getintegrationv1brand119storelocatorcustomfieldsmap.md): Endpoint for GET /integration/v1/brand/119/store-locator/custom-fields/map
- [Send communication message](https://docs.capillarytech.com/reference/v2-send-communication-message.md): This API allows you to send communication message using SMS/WhatsApp/Zalo or Email as a communication channel. You can use it to send messages to a single customer or to multiple customers in bulk.
- [Resend a communication message](https://docs.capillarytech.com/reference/post_v2-communications-resend.md)
- [Error code](https://docs.capillarytech.com/reference/error-code-copy.md)
- [Communications (v1)](https://docs.capillarytech.com/reference/communications.md)
  - [Send communication message](https://docs.capillarytech.com/reference/send-communication-message.md): This API allows you to send communication message using SMS/WhatsApp/Zalo or Email as a communication channel.
  - [Error code](https://docs.capillarytech.com/reference/error-code.md)
- [Create a Custom Field](https://docs.capillarytech.com/reference/create-a-custom-field.md)
- [Get Custom Fields](https://docs.capillarytech.com/reference/get-custom-fields.md)
- [Audit logs](https://docs.capillarytech.com/reference/audit-logs.md): The APIs retrieve audit logs of entities and for specific behavioral events. The APIs provide detailed records of actions and events associated with the selected entities or event names.
  - [Get audit logs of entities](https://docs.capillarytech.com/reference/get-entity-audit-logs.md): This page provides you with information on entity audit log API.
  - [Get Audit Logs by Event Name](https://docs.capillarytech.com/reference/get-audit-logs.md): Retrieves events' audit log details.
- [PII deletion](https://docs.capillarytech.com/reference/pii-deletion.md): Personal Identifiable Information is defined as any information that can be used to identify someone.
  - [Add a PII deletion request](https://docs.capillarytech.com/reference/add-a-pii-deletion-request.md): The PII deletion request API allows you to raise a PII deletion request.
  - [Update PII deletion status](https://docs.capillarytech.com/reference/update-pii-deletion-status.md): Allows to approve or reject the deletion requests and update the deletion status accordingly.
  - [Retrieve request status of PII deletion](https://docs.capillarytech.com/reference/retrieve-pii-deletion-request-status.md): Allows you to retrieve status of the PII deletion request that you raised.
  - [Retrieve Request Details using Type and Subtype](https://docs.capillarytech.com/reference/retrieve-pii-deletion-request-details.md): Allows you to retrieve request details with desired filters.
  - [Error codes](https://docs.capillarytech.com/reference/pii-deletion-error-codes.md): This section lists the possible error codes and the action required.
- [Leads](https://docs.capillarytech.com/reference/leads.md)
  - [Add Lead](https://docs.capillarytech.com/reference/add-lead-1.md): Adds a new lead. A new non-loyalty customer will be created if you pass a new customer identifier.
  - [Add Lead Substatus](https://docs.capillarytech.com/reference/create-lead-substatus.md): Lets you create a new sub-status to a lead status.
  - [Update Lead Status](https://docs.capillarytech.com/reference/update-lead-status.md): Updates the status and substatus of an existing lead. You can have status as OPEN (for new lead), WON (for a successful purchase lead), LOST (for unreverted lead), ON_HOLD, DELETED.
  - [Update Lead Followups](https://docs.capillarytech.com/reference/update-lead-followups.md): Lets you update the recent follow up date and till id of a lead.
  - [Update Lead](https://docs.capillarytech.com/reference/update-lead.md): Updates extended fields for an existing lead
  - [Configure lead reasons](https://docs.capillarytech.com/reference/set-lead-reasons.md): Lets you add your preferred reasons that are required while adding or updating a lead at the organization level.
  - [Get Lead Status Log](https://docs.capillarytech.com/reference/get-lead-status-log.md): Retrieves the status change log of a specific lead.
  - [Get Lead follow-ups](https://docs.capillarytech.com/reference/get-lead-follow-ups.md): Retrieves the follow ups of a specific lead.
  - [Get Lead Reasons](https://docs.capillarytech.com/reference/get-lead-reasons.md): Retrieves the list of reasons added for the org with reason ids. These reason ids are required to create or update leads.
  - [Get Lead Details](https://docs.capillarytech.com/reference/get-lead-details.md): Retrieves the details of leads created in an org. You can use filter parameters to get personalized results.
  - [Get Lead Substatus](https://docs.capillarytech.com/reference/get-lead-substatus.md): Retrieves all the sub-statuses added (for each status) to the organization.
  - [Search lead](https://docs.capillarytech.com/reference/search-lead.md)
  - [Assign Lead](https://docs.capillarytech.com/reference/assign-lead.md): Lets you change the owner of an existing lead.
- [Staff](https://docs.capillarytech.com/reference/staff.md): A Staff is an org employee who deals with selling items to end-users. This concept is introduced mainly for B2B marketing. This resource contains APIs related to managing staff accounts. The staff…
  - [Add Staff Account](https://docs.capillarytech.com/reference/add-staff-account.md): Lets admin users to create a staff account for the organization.
  - [Get Access Token](https://docs.capillarytech.com/reference/get-access-token.md): Generates access token (entity param in response) for a staff. No POST body required.
  - [Edit Staff Details](https://docs.capillarytech.com/reference/edit-staff-details.md): Updates profile information of the respective staff user. You can use direct login or token based login. You need a new header X-CAP-API-ACCESS-TOKEN for token based authentication.
  - [Get Staff Details](https://docs.capillarytech.com/reference/get-staff-details.md): Retrieves the details of a specific staff.
  - [Change Account Password](https://docs.capillarytech.com/reference/change-account-password.md): Lets you change the password of the staff using the associated Auth or AccessToken. Either you can use the auth or the login credentials.
  - [Send OTP](https://docs.capillarytech.com/reference/send-otp.md): Lets admin users to create a staff account for the organization.
  - [Validate OTP](https://docs.capillarytech.com/reference/validate-otp-1.md): Lets admin users validate OTP sent to the staff’s registered mobile number or email id through the `staff/sendOtp` API.
  - [Change Identifier (Send OTP)](https://docs.capillarytech.com/reference/change-identifier-send-otp.md): Sends a validation OTP to the registered mobile number/email id of the staff  to change identifier.   Changing identifier involves two step -  1. Send OTP to the new identifier (current API) 2.…
  - [Change Identifier (Validate OTP)](https://docs.capillarytech.com/reference/change-identifier-validate-otp.md): Lets you validate the OTP sent through /changeidentifier/sendotp API to change the identifier of a staff.   Changing identifier is a two step process -  1. Send OTP to the new identifier (previous…
  - [Transfer Staff User](https://docs.capillarytech.com/reference/transfer-staff-user.md): Lets admin user change the store id associated to a staff user.
  - [Get Staff of Store/Zone](https://docs.capillarytech.com/reference/get-staff-of-storezone.md): Retrieve registered staff users of a specific store or zone. Accessible only to admin users.
  - [Logout Staff Account](https://docs.capillarytech.com/reference/logout-staff-account.md): Logs out the current staff user’s access token (only for token based authentication). You need to pass the new header X-CAP-API-ACCESS-TOKEN which is the user’s access token.
  - [Remove Staff Account](https://docs.capillarytech.com/reference/remove-staff-account.md): Deactivates an existing account of staff user.
- [Behavioral Events](https://docs.capillarytech.com/reference/behavioral-events-and-status-code.md): Behavioral events help capture customer activities such as registration, forgot password, and cart abandonment.   There are standard events that are predefined with name, id, and attributes.   The…
  - [Create Event (Custom)](https://docs.capillarytech.com/reference/create-event-custom-be.md): Lets you create a new behavioral event.
  - [Update Event (Custom)](https://docs.capillarytech.com/reference/update-event-custom.md): Lets you add or remove fields and customers for an event. You need to pass the entire payload of the event.
  - [Get Org Events](https://docs.capillarytech.com/reference/get-org-all-events.md): Retrieves all events configured for the org. This includes both standard and custom events.  You can also use the query parameter to fetch details of a specific event.
  - [Get Running Events Status](https://docs.capillarytech.com/reference/get-running-event-status.md): Retrieves the current status of live events.
  - [Get Customer Events](https://docs.capillarytech.com/reference/get-customer-events-data.md): Retrieves the details of all events of a specific customer.
  - [Disable Event](https://docs.capillarytech.com/reference/disable-event.md): Lets you disable an existing event. You cannot restore an event once disabled.
  - [Add Webhook](https://docs.capillarytech.com/reference/add-webhook.md): A Webhook (also called a web callback or HTTP push API) is a way for an app to provide other applications with real-time information. A `webHookUri` is generated which can be used for the integration.
  - [Get Org Webhooks](https://docs.capillarytech.com/reference/get-webhook-details.md): Retrieves details of all Webhook accounts created for the organization. An org can have one Webhook account per transformer.
  - [Get Events Logs](https://docs.capillarytech.com/reference/get-events-logs.md): Retrieves the log of all events of the org.
  - [Get Events Meta](https://docs.capillarytech.com/reference/get-events-meta.md): Retrieves the specified event's metadata.
  - [Get event data using request ID](https://docs.capillarytech.com/reference/get-specific-event-data.md): Retrieves details of a specific events.
  - [Search events](https://docs.capillarytech.com/reference/search-events.md)
  - [Post Event](https://docs.capillarytech.com/reference/post-event.md): Lets you post the behavioral event.
- [Event notification logs](https://docs.capillarytech.com/reference/event-logs.md)
  - [Add Webhook](https://docs.capillarytech.com/reference/add-v3-webhooks.md): Add a new webhook for event notification.
  - [Get Webhook](https://docs.capillarytech.com/reference/get-v3-webhooks.md): Retrieve details of all the webhooks.
  - [Update Webhook](https://docs.capillarytech.com/reference/update-v3-webhook.md): Update an existing webhook.
  - [Delete Webhook](https://docs.capillarytech.com/reference/delete-v3-webhook.md): Delete a webhook.
  - [Get Event Log (by Request ID)](https://docs.capillarytech.com/reference/get-event-log-by-request-id-.md)
  - [Get Event Log (by Reference ID)](https://docs.capillarytech.com/reference/get-event-log-by-reference-id-.md): Retrieves the details of a specific event call based on the reference ID of the request.
  - [Get Event Log (by Event ID)](https://docs.capillarytech.com/reference/get-event-log-by-event-id.md)
  - [Get Event Logs by Webhook ID](https://docs.capillarytech.com/reference/geteventsbyconsumergroupid.md): Endpoint for GET /v3/events/consumer-groups/d7022e0e-35ad-4c81-a18a-a6cb32ee6292/logs
  - [Get Event Matrix by Webhook ID](https://docs.capillarytech.com/reference/geteventmatrix.md): Endpoint for GET /v3/events/consumer-groups/0c3ad68c-06e3-4947-85df-4df10e898eeb/metrics
  - [Response code](https://docs.capillarytech.com/reference/response-codes.md)
- [Company](https://docs.capillarytech.com/reference/company-1.md): Company is an entry in the fleet hierarchy.  An org can have child and parent companies. This entity contains APIs to manage companies of the org.
  - [Add Company](https://docs.capillarytech.com/reference/add-company.md): Lets you add a new company to the org.
  - [Update Company](https://docs.capillarytech.com/reference/update-company.md): Lets you update details of a company.
  - [Get Company Details](https://docs.capillarytech.com/reference/get-company-details.md): Retrieves details of a company by company ID or external ID.
  - [Remove Company](https://docs.capillarytech.com/reference/remove-company.md): Lets you delete an existing company. The company and its associated sub-companies will go inactive. However, the customers associated with the company will still remain active.
  - [Get Org Companies](https://docs.capillarytech.com/reference/get-org-companies.md): Retrieves all companies of the org. Use filter parameters to get specific details.
  - [Get Companies by Extended Field Values](https://docs.capillarytech.com/reference/get-companies-by-extended-field-values.md): Fetches companies using the first few values of an extended field value provided.
- [Request (V1)](https://docs.capillarytech.com/reference/request.md): Request entity contains APIs corresponding to submitting and retrieving requests. In Capillary APIs, requests are of two types - Change Identifier and Goodwill. Request APIs allow you to change…
  - [Add Request](https://docs.capillarytech.com/reference/add-request.md): Lets you submit requests for customer identifier changes. It could be either mobile number, email ID, or external ID.
  - [Approve Requests](https://docs.capillarytech.com/reference/approve-requests.md): Allows approving requests that are in pending status. You can use this API only when the auto-approval configurations are not enabled for your organization. Also, you cannot approve force approval…
  - [Reject Requests](https://docs.capillarytech.com/reference/reject-requests.md): Allows rejecting requests that are in pending status. You can use this API only when the auto-approval configurations are not enabled for your organization. Also, you cannot reject force approval…
  - [Get Request Details](https://docs.capillarytech.com/reference/get-request-details.md): This API allows you to retrieve up to 50 records containing goodwill and change identifier requests.  It is the sub-set of request/logs API.   You can filter requests by customer and request type…
  - [Get Request Logs](https://docs.capillarytech.com/reference/get-request-log.md): Retrieves the request logs of a specific duration. You can retrieve the either the logs of `CHANGE_IDENTIFIER` or `GOODWILL`.
- [Requests (V2)](https://docs.capillarytech.com/reference/requests.md): Request entity contains APIs corresponding to submitting and retrieving requests.
  - [Add Request](https://docs.capillarytech.com/reference/add-request-transaction-customer-merge.md): Add a transaction or customer merge request
  - [Update Request](https://docs.capillarytech.com/reference/update-transaction-customer-merge-request.md): Update transaction or customer merge requests.
  - [Retrieve Request Status using ID](https://docs.capillarytech.com/reference/retrieve-transaction-customer-merge-request-status.md): Allows you to retrieve status of Customer Merge or Transaction requests.
  - [Retrieve Request Details using Type and Subtype](https://docs.capillarytech.com/reference/retrieve-transaction-customer-merge-request-details.md): Allows you to retrieve request details with desired filters.
  - [Status event notification](https://docs.capillarytech.com/reference/request-event-notification.md)
  - [Error codes](https://docs.capillarytech.com/reference/error-codes.md): This section lists the possible error codes and the action required.
- [Request workflow](https://docs.capillarytech.com/reference/request-workflow.md)
  - [Create a request](https://docs.capillarytech.com/reference/create-a-request.md)
    - [Change customer status request](https://docs.capillarytech.com/reference/change-customer-status.md)
    - [Points redemption request](https://docs.capillarytech.com/reference/points-redemption.md)
    - [Issue goodwill points request](https://docs.capillarytech.com/reference/issue-goodwill-points.md)
    - [Issue/Earn badge request](https://docs.capillarytech.com/reference/earn-badge-issue-badge-to-single-customercustomer-earns-the-badge.md)
    - [Enrol customers for badges](https://docs.capillarytech.com/reference/issue-badge-enrol-customers-for-badges.md)
    - [Retro transaction - Claim transaction](https://docs.capillarytech.com/reference/retro-transaction-claim-transaction.md)
  - [Approve or reject a request](https://docs.capillarytech.com/reference/approve-or-reject-a-request.md): This API enables you to approve or reject a request
  - [Get details of all requests](https://docs.capillarytech.com/reference/get-all-requests.md): This API enables you to retrieve details of the all requests.
  - [Get details of a particular request](https://docs.capillarytech.com/reference/get-request-info.md): This API enables you to retrieve details of a particular request.
  - [Error codes](https://docs.capillarytech.com/reference/error-codes-request-workflow.md)
- [Partner Program](https://docs.capillarytech.com/reference/partner-program.md)
  - [Update Customer Tier](https://docs.capillarytech.com/reference/update-customer.md): Lets you update tier details of a customer in one or more partner programs.
  - [Delink Customer](https://docs.capillarytech.com/reference/delink-customer.md): Lets you remove a customer from one or more partner programs.
  - [Get customer activity history](https://docs.capillarytech.com/reference/customeractivityhistories.md)
- [User Authentication](https://docs.capillarytech.com/reference/user-authentication.md): The userAuth resource allows existing customers of InStore to register on the org’s web page/mobile app, authenticate login credentials, and update user details.
  - [Register User](https://docs.capillarytech.com/reference/register-users.md): Lets the org’s InStore customers to register on their web page or mobile app. You need to use only the mobile number/email ID that is registered on InStore.
  - [Authorize User](https://docs.capillarytech.com/reference/authorize-user.md): Validates whether the provided user credentials are valid or not.
  - [Update Password](https://docs.capillarytech.com/reference/update-password.md): Allows updating the password of a user account.
- [OTP](https://docs.capillarytech.com/reference/otp.md): This page consists of APIs related to OTPs that are used to validate customers.The functionality of OTPs depends on the configuration set on InTouch
  - [Generate OTP](https://docs.capillarytech.com/reference/generate-otp.md): This page provides you with information on generating OTP.
    - [OTP template guidelines](https://docs.capillarytech.com/reference/otp-template-guidelines.md): This page provides you with information on creating an OTP template for SMS, Email, WhatsApp and ZALO, and on the OTP workflow.
  - [Validate OTP](https://docs.capillarytech.com/reference/validate-otp.md): Lets you authenticate customer by validating the OTP sent to the customer through SMS or email and proceed with the necessary action such as redeeming points/coupons, and registering customer.  In…
  - [Get OTP](https://docs.capillarytech.com/reference/get-otp.md): Allows fetching recent OTP issued to a customer. For now, OTP is issued for redeeming points/coupons and customer registration. If there is more than one valid OTP available for the customer, this…
  - [Success and error codes](https://docs.capillarytech.com/reference/success-and-error-codes.md): This page provides you with information on success and error codes associated with OTP API.
- [Task](https://docs.capillarytech.com/reference/task.md): Tasks could be any activity created by an associate for oneself or for other associate. The task entity allows you to create, update and map tasks and retrieve the details of tasks created in your…
  - [Add Tasks](https://docs.capillarytech.com/reference/add-tasks.md): Creates new store task and store task entry ( that is status for each executor ). You can also set task type, title, created by, assigned to, validity, status and reminder.
  - [Update Tasks](https://docs.capillarytech.com/reference/update-tasks.md): Updates the status of existing tasks and metadata details.
  - [Get Tasks Metadata](https://docs.capillarytech.com/reference/get-tasks-metadata.md): Returns the list of tasks created which contains information such as the title of the task, notes, created date, expiry date, type (customer/associate).  You can also use filters to limit or…
  - [Get Task Logs](https://docs.capillarytech.com/reference/get-task-logs.md): Returns the log of task updates
  - [Update Status Mappings](https://docs.capillarytech.com/reference/update-status-mappings.md): Lets you update mappings between the predefined and the user-defined statuses.
  - [Get Status Mappings](https://docs.capillarytech.com/reference/get-status-mappings.md): Returns mapping between predefined status and user-defined status.
  - [Get Task Reminders](https://docs.capillarytech.com/reference/get-task-reminders.md): Returns reminders of all tasks.
  - [Create/Update Task Reminders](https://docs.capillarytech.com/reference/createupdate-task-reminders.md): Creates new task reminders or updates existing reminders.
  - [Retrieve Individual Task Details](https://docs.capillarytech.com/reference/retrieve-individual-task-details.md): Returns the information about individual tasks such as created by, assigned to, task type, created at store and current status.
- [Generate Authentication Token](https://docs.capillarytech.com/reference/generate-authentication-tokenapi.md): Generate authentication for web application.
- [Generate OTP](https://docs.capillarytech.com/reference/generate-otp-api.md): This page provides you with information on Generate OTP API.
- [Validate OTP](https://docs.capillarytech.com/reference/validate-otp-api.md): Validates the OTP generated through the `/otp/generate` API.
- [Validate Password](https://docs.capillarytech.com/reference/validate-password.md): Validates the password of an existing user account
- [Regenerate Authentication Token](https://docs.capillarytech.com/reference/regenerate-authentication-token.md): Generates authentication token using auth key or expired token generated in `otp/validate` API. By default, a token is valid for 15 minutes. You can use this API only for orgs in which password based…
- [Change Password](https://docs.capillarytech.com/reference/change-password.md): Lets you modify the current password of a customer. This is applicable only for brands for which password is enabled.
- [Forget Password](https://docs.capillarytech.com/reference/forget-password.md): Lets you set a new password if the customer has lost or forgot password. This is applicable only for brands for which password is enabled. You need to first generate sessionId and then use it in…
- [Status codes](https://docs.capillarytech.com/reference/status-codes.md): This page displays the success and error codes associated with the the authentication APIs.
- [Multi-factor authentication](https://docs.capillarytech.com/reference/multi-factor-authentication.md): This page provides you with information on multi-factor authentication.
  - [Generate MFA token](https://docs.capillarytech.com/reference/generate-mfa-token.md): Generates MFA token for devices.
  - [Generate MFA OTP](https://docs.capillarytech.com/reference/generate-otp-mfa.md): Generates OTP for MFA flow.
  - [Validate MFA OTP](https://docs.capillarytech.com/reference/validate-mfa-otp.md): Validates the OTP generated for the MFA flow.
  - [MFA password flow](https://docs.capillarytech.com/reference/mfa-password-flow.md): This section gives the details on MFA password flow.
    - [Validate password](https://docs.capillarytech.com/reference/validate-mfa-password.md): Validate the entered password.
    - [Change password](https://docs.capillarytech.com/reference/change-mfa-password.md): API to change the password.
    - [Forgot password](https://docs.capillarytech.com/reference/mfa-forgot-password.md): Generate new password when you forget your password.
  - [Regenerate token](https://docs.capillarytech.com/reference/regenerate-token.md): MFA token regeneration.
  - [Check if MFA is Registered](https://docs.capillarytech.com/reference/check-if-mfa-is-registered.md)
  - [Delete token](https://docs.capillarytech.com/reference/delete-token.md): Delete or expire token generated by MFA OTP or password validation APIs.
- [Authentication configurations](https://docs.capillarytech.com/reference/authentication-configurations.md)
- [Refer Customer](https://docs.capillarytech.com/reference/refer-customer.md)
- [Add Referrals](https://docs.capillarytech.com/reference/get-referrals.md): Lets you add customer referral details that contain referees, referred date, and the associated channel.
- [Validate Referral Code](https://docs.capillarytech.com/reference/validate-referral-code.md): Lets you validate referral code received by the referee.
- [Connect+ DIY Template APIs](https://docs.capillarytech.com/reference/diy-template-apis.md)
  - [Create DIY Template](https://docs.capillarytech.com/reference/post-create-api-diy-template-connectplus.md): Create a DIY template
  - [Retrieve Workspaces](https://docs.capillarytech.com/reference/get-workspaces-diy-connectplus-template.md): Retrieves the workspace ID
  - [Retrieve Blocks Supported by the Template](https://docs.capillarytech.com/reference/get-processor-diy-connectplus-template.md): Fetches the blocks supported by the DIY template
- [Trigger Walk-in Notifications on InStore](https://docs.capillarytech.com/reference/trigger-walk-in-notifications-on-instore.md): Triggers customer walkin notifications on InStore. That is, when a customer walks in to the store, InStore triggers a desktop notification with the customer details.
- [Get Transaction Earning](https://docs.capillarytech.com/reference/get-transaction-earning.md): Retrieves the details of all points earned for a transaction.
- [Update Currency Ratio](https://docs.capillarytech.com/reference/update-currency-ratio.md): Lets you add or update currency ratios with respect to Indian Rupee (INR).
- [Configure Org Extended Field](https://docs.capillarytech.com/reference/configure-org-extended-field.md): This API lets you configure a extended field for the org and manage whether to show or hide it on your org’s InTouch.
- [Get Org Extended Fields](https://docs.capillarytech.com/reference/get-org-extended-fields.md): Retrieves the details of all extended fields configured for the organization. You can see the extended fields for each category.
- [Create Store Associates](https://docs.capillarytech.com/reference/create-store-associates.md): Allows adding new associates to a store. Only admin users of the org can create associates.
- [Feed (Scan Event)](https://docs.capillarytech.com/reference/feed-scan-event.md): Captures details of an events based on qrcodes ,menuclick, and getpromotion.
- [Get Configured Card Limit per Customer](https://docs.capillarytech.com/reference/get-configured-card-limit-per-customer.md): Retrieves the configured maximum number of cards active cards per customer.
- [Get Org Sources](https://docs.capillarytech.com/reference/get-org-sources.md): ​ Retrieves all sources configured for the org along with the supported communication channels for each source.
- [Get org configs](https://docs.capillarytech.com/reference/get-org-config-key-values.md): Retrieves the organization configuration values based on config name.
- [Retrieve extended field config details](https://docs.capillarytech.com/reference/retrieve-extended-field-config-details.md)
- [SCIM](https://docs.capillarytech.com/reference/scim.md)
  - [Create SCIM Token](https://docs.capillarytech.com/reference/create-scim-token.md): Generate a SCIM provisioning token for one or more organizations.
  - [Revoke SCIM Token](https://docs.capillarytech.com/reference/revoke-scim-token.md): Revoke the active SCIM provisioning token for one or more organizations.
  - [Create User](https://docs.capillarytech.com/reference/create-user.md)
  - [Get List of User](https://docs.capillarytech.com/reference/get-list-of-user.md)
  - [Get User by Filter name](https://docs.capillarytech.com/reference/get-users-by-filter-name.md)
  - [Get User by SCIM Id](https://docs.capillarytech.com/reference/get-users-by-scim-id.md)
  - [Create Group](https://docs.capillarytech.com/reference/create-group.md)
  - [Add or Remove group members](https://docs.capillarytech.com/reference/add-group-members.md)

## API Documentation: PLUGINS
- [Shopify plugin](https://docs.capillarytech.com/reference/shopify-plugin.md): You can integrate Capillary with Shopify and activate a loyalty program for your website.
- [Magento plugin](https://docs.capillarytech.com/reference/magento-plugin.md): You can integrate Capillary with Magento and activate a loyalty program for your website.

## Pages
- [Developer Documentation](https://docs.capillarytech.com/page/developerdocumentation.md)
- [Landing Page](https://docs.capillarytech.com/page/loyalty.md)
- [Release Notes](https://docs.capillarytech.com/page/product-release-notes.md)