DOCSEARCHbyAlgolia
Submit Docs

Mercury Documentation

website·Indexed 31 days ago

https://docs.mercurycloud.studio

Documentation for Mercury, a platform for managing personalized loyalty engines and multi-channel marketing campaigns. Includes guides for loyalty program configuration, campaign management via Email, SMS, and Viber, survey building, and a RESTful API for messaging and invitations.

Tokens
19K
Snippets
30
Records
142
Agent score
52%

What's inside Mercury

  1. Overview of Mercury Loyalty Engine capabilities

    The Mercury loyalty engine allows operators to implement personalized reward strategies across multiple brands. The system provides centralized management for the following loyalty components:

    • Loyalty Programs: Brand-specific configurations and operational rules.
    • Tiers: Customizable membership levels (e.g., Bronze, Silver, Gold) defined by specific thresholds and associated benefits.
    • Points Rules: Logic defining the mechanisms for how customers earn and redeem loyalty points.
    • Rewards & Perks: Management of tangible and intangible incentives such as vouchers, gifts, and exclusive offers.
    • Redemptions: Tracking and auditing of reward usage and overall customer engagement.

    All loyalty management tools are located within the LOYALTY section of the sidebar navigation.

  2. Manage Loyalty Programs overview

    The Loyalty Programs section allows you to define and manage the core configuration of the loyalty engine for each brand. You can create multiple programs tailored to specific brands or audience groups to control how customers earn, retain, and redeem points. From the Program List, you can create new programs via the 'New Loyalty Program' button or edit/delete existing ones using the Actions column.

  3. Understand the types of Loyalty Rewards

    Mercury Cloud supports two types of rewards:

    • Tier-based perks (TierReward): These are automatically available to members in a specified tier and all higher tiers. They do not require the member to spend points.
    • Redemption rewards (RedemptionReward): These require members to spend (or "burn") a specific number of points to claim the benefit.

  4. Customize survey visual appearance with the Theme Editor

    The Mercury Cloud Theme Editor allows you to control the visual design of surveys. You can use the built-in Light and Dark themes, create a custom theme from scratch, or derive a new custom theme from an existing one. The editor controls the following design elements:

    • Typography styles
    • Text and background colors
    • Background images
    • CTA button styling and hover effects
    • Custom CSS rules for advanced design requirements.

  5. Mercury Cloud API Overview

    Mercury provides a standard RESTful API where all requests and responses use JSON. The API follows standard HTTP verb conventions: GET for retrieving resources, POST for creating new resources, and PUT for updating existing resources.

  6. Manage surveys in the Surveys list

    The Surveys section provides a high-level overview of all surveys, showing their current status (active or inactive) and the total number of submissions. From this list, users can filter and sort surveys via table headers, edit existing surveys, delete them, clone them, or click the submission count to view individual responses.

  7. Navigate the Mercury Cloud Studio Sidebar Menu

    The left-hand sidebar provides access to all Mercury functionality, organized into the following primary sections:

    • Dashboards: High-level performance overviews of CRM and loyalty programs.
    • Campaigns: Tools for personalized communication, including the Campaigns list (Email, SMS, Viber), Campaign Calendar, Automations (transactional messages/user journeys), Templates, Segments for targeting, and Touchpoints for thematic grouping.
    • Surveys: Management of NPS, CSAT, and feedback forms, including visual Themes.
    • Loyalty: Configuration of loyalty rules, reward periods, reward types, and Redemptions tracking.
    • Audience: Customer data management including Consumers (360° view), Transactions (purchases/returns), Subscribers, and Subscriber Groups.
    • Reports: Analytical tools for CRM (database/recruitment), Marketing (campaign/automation performance), and Loyalty (coupons/referrals).
    • System: Administrative controls including User permissions, global Settings, Lookups (system lists), Tags, Brand configurations, Store locations, Product catalogs, Data Importer (CSV/Excel), and System Logs.

  9. Manage and monitor campaigns in the Campaigns List

    The Campaigns List provides a centralized view of all past, ongoing, and scheduled campaigns across Email, SMS, and Viber channels. Users can sort campaigns by clicking column headers or filter them by date, channel, or campaign title. Delivery status is indicated by a color-coded progress bar: Purple (Scheduled), Yellow (Queued), Green (Delivered), and Red (Bounced or failed).

  10. Manage user roles in the Mercury Admin Console

    The Roles module allows administrators to define sets of permissions that control which areas of the system a user can access and what actions they can perform. From the Manage Roles screen, administrators can filter or search roles, export the list (Excel, CSV, PDF), perform bulk deletions or toggle built-in status, and create or edit roles.

  11. Generate and validate Apple Wallet passes in Mercury

    Mercury generates Apple Wallet passes as .pkpass files at runtime and serves them via the API endpoint. To verify the validity of a generated pass, upload the .pkpass file to the Pkpass Validator tool.
    // Mercury generates Apple Wallet passes via this method
PassesHelper.GenerateApplePassForCard

  12. Use the HTML Editor for precise email design

    The HTML Editor is used for existing HTML templates or designs requiring pixel-level control. Key features include:

    • Source Code View: Accessible via the first button on the top row to edit raw HTML.
    • Image Uploads: Images dropped directly into the editor are automatically uploaded to the server.
    • Slicing Tool: Used to split uploaded images into smaller sections with clickable hotspots.
    • Token Tool (T): Used to insert personalization placeholders into the template.