Qliam: Official Documentation

1. Core Concepts & Architecture

Qliam operates on a Multi-Tenant Architecture designed for scale and security. Understanding this hierarchy is the key to mastering the platform.

• Organizations: The top-level entity (e.g., your agency, company, or freelance business). Billing, global settings, and team members are managed here.
• Projects: Workspaces within an Organization. Each project represents a specific website, app, or client. Projects have isolated API keys, templates, contact forms, and email logs.
• Team Roles: Invite users as Owners, Managers, or Members to control access at both the Organization and Project levels.

2. Getting Started

Step 1: Create a Project

1. Log in to your Qliam dashboard.
2. Navigate to your Organization and click New Project.
3. Name your project (e.g., "My E-commerce App") and define the Allowed Domain. This secures your API and ensures emails only trigger from authorized origins.

Step 2: Generate API Keys

Every project requires an API key to communicate with the Qliam edge servers.

1. Open your new Project and go to Settings > API Keys.
2. Generate a new key and store it securely in your application's .env file. Note: You will not be able to see this key again once you close the window.

3. The Visual Template Engine

Qliam features a powerful drag-and-drop template builder, allowing you to design premium emails without writing HTML.

Template Types

When creating a template, you must assign it a type:

• Marketing: For newsletters, promotional blasts, and product updates.
• Transactional: For password resets, receipts, and account verifications.
• Notification: For internal alerts, contact form submissions, and system events.

Using Dynamic Variables

You can inject dynamic data into your templates using Handlebars syntax.

1. In the text editor of your template, type a variable like {{first_name}} or {{order_total}}.
2. When you trigger an email via the API, pass a JSON object containing those exact keys. Qliam will seamlessly merge the data and compile the final HTML before delivery.

4. AI Template Copilot

Designing premium emails from scratch can be time-consuming. Qliam includes a powerful AI Template Copilot powered by Google Gemini, allowing you to generate complete, production-ready email layouts in seconds.

Whether you want strict structural guardrails or complete creative freedom, the Copilot adapts to your workflow.

Accessing the Copilot

1. Navigate to Templates and click New Template (or edit an existing one).
2. On the left side of the visual editor, locate the AI Assistant sidebar.

Choose Your Generation Mode

At the top of the AI sidebar, you can toggle between two distinct generation modes based on your needs:

Option A: Guided Mode (Structured Compiler)

Ideal for maintaining strict brand consistency and precise layouts. Instead of guessing how to talk to the AI, Guided Mode breaks your request down into specific architectural components. The engine automatically compiles these into a highly accurate master layout.

• Header: Define the top of your email (e.g., "Company logo centered with minimal padding").
• Hero Section: Describe the main headline and introductory text (e.g., "A bold 'Welcome Aboard' headline with a short paragraph thanking the user").
• Grid Content: Select between 1 to 3 columns for your main content body, and explicitly describe the text or imagery for each column.
• Call to Action (CTA): Define the primary button text and its intended action URL.
• Footer: Specify unsubscribe text, company address, or legal links.

Option B: Freeform Mode (Prompt Mode)

Ideal for power users, rapid iteration, or wildly creative campaigns.

• Select Freeform, and the structured fields will collapse into a single, expansive text area.
• Paste in massive custom instructions, context from your marketing team, or simple one-liners (e.g., "Design a dark-mode Halloween newsletter with a 2-column product grid and a massive orange checkout button.").

Parametric Design Guides

Regardless of whether you use Guided or Freeform mode, you can strictly enforce your brand identity using the Design Guides panel locked at the bottom of the sidebar:

• Primary Color: Click the swatch to open the visual color picker or paste your brand's exact Hex code. The AI will strictly apply this to your primary buttons and accents.
• Background Color: Define the main container color for the email (perfect for forcing native dark-mode or light-mode layouts).
• Font Family: Select from our list of web-safe, universally supported email fonts. The dropdown provides live visual previews of each typeface.

Generating and Editing

1. Once your mode is selected and parameters are set, click Generate Magic Template.
2. The AI will process your instructions and instantly render the fully editable design directly onto your canvas.
3. Because the output is native component data, you can immediately click on any generated text, image, or button to manually refine the design using the standard drag-and-drop tools.

5. Headless Contact Forms

Qliam completely eliminates the need for backend code to process website contact forms.

Step 1: Create the Form in the Dashboard

1. Navigate to Contact Forms within your Project.
2. Click Add New Form. Give it a name and specify the destination email address (where the submissions should be sent).
3. Link a Template: Select a "Notification" template (e.g., "New Contact Submission") from your library. This dictates how the email will look when it arrives in your inbox.

Step 2: Connect Your Frontend

To submit data from your website, make a standard POST request to the Qliam API. No backend server is required.

// Example: Sending form data from a Next.js or React frontend
const submitForm = async (formData) => {
  const response = await fetch('https://api.qbixlabs.com/v1/forms/[YOUR_FORM_ID]/submit', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      // Depending on your security settings, origin headers will be verified here
    },
    body: JSON.stringify({
      name: formData.name,
      email: formData.email,
      message: formData.message
    })
  });

  if (response.ok) {
    console.log("Form submitted successfully!");
  }
};

The API will automatically map the name, email, and message fields to the {{name}}, {{email}}, and {{message}} variables in your linked template.

6. API Integration (Sending Transactional Emails)

For custom application logic, you can trigger emails directly using our Edge-optimized API.

Endpoint

POST https://api.qbixlabs.com/v1/emails/send

Authentication

Include your Project API Key in the Authorization header.

Request Payload Example

{
  "to": "user@example.com",
  "template_id": "your-template-uuid",
  "variables": {
    "first_name": "Tharusha",
    "receipt_url": "https://myapp.com/receipt/123"
  }
}

curl -X POST "https://api.qbixlabs.com/v1/emails/send" \
     -H "Authorization: Bearer YOUR_PROJECT_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{
           "to": "customer@example.com",
           "template_id": "123e4567-e89b-12d3-a456-426614174000",
           "variables": {
             "first_name": "Alex"
           }
         }'

7. Audience & Campaigns (CRM)

Qliam includes a built-in CRM to manage your audience and broadcast campaigns.

• Subscribers: Add subscribers manually, via CSV import, or automatically through API integrations.
• Tags & Segments: Apply tags (e.g., premium_user, newsletter_opt_in) to subscribers to create targeted lists.
• Campaigns: Create a new Campaign, select a Marketing template, choose your target segment (or "All Subscribers"), and schedule the delivery.
• Tracking: Qliam automatically injects tracking pixels and link wrappers to monitor open rates and click-through rates in real-time.

8. Logs & Observability

Every action in Qliam is tracked for total transparency.

Navigate to the Logs tab in your Project to view a chronological feed of all API requests and email deliveries.

• Status Indicators: Instantly see if an email was Sent, Delivered, Opened, Bounced, or Failed.
• Payload Inspection: Click on any log entry to view the exact JSON payload your application sent, making debugging API variable mismatches incredibly simple.