Documentation
🏷️ White-Label Guide

White-Label Holder Reference

Role: tenant.admin · Access: /portal-admin · 10 sections · ~8 min read · 🔒 Private

What Is White-Label?

As a white-label holder you run your own branded instance of the Viraloo giveaway platform. Your clients log in under your domain and see your brand — your name, logo, and colors — while Viraloo powers everything behind the scenes.

You manage clients and their campaigns through the Portal Admin panel, and configure branding, email, and billing independently from the main Viraloo platform.

Portal Admin Dashboard

Access your portal at https://yourdomain.com/portal-admin.

KPI CardWhat it shows
Total ClientsAll white-label users on your portal
Total CampaignsAll campaigns created by your clients
Active CampaignsCampaigns currently live
Total ParticipantsCombined entry count across all client campaigns

Client Management

Go to Portal Admin → Users (/portal-admin/users).

Add a Client

  1. Click Add Client
  2. Fill in name, email, password, and plan
  3. Click Create — client receives welcome email and can log in immediately

Edit a Client

  1. Click Edit next to any client
  2. Update name, email, plan, or password
  3. Suspend the account if needed → Save

Suspend / Reactivate

Suspending blocks login while preserving all data. Use this for non-payment, terms violations, or accounts on hold. Reactivating restores full access immediately.

Campaign Oversight

Go to Portal Admin → Campaigns (/portal-admin/campaigns) to see every campaign across all clients — filterable by client, status, and date. Monitor participant counts and referral activity from here.

Portal Settings

Go to Portal Admin → Settings (/portal-admin/settings). All settings here apply only to your white-label portal — they do not affect the main Viraloo platform or other portals.

🏷 Brand

SettingDescription
Portal / Brand NameAppears in navigation, emails, and browser tab
Logo URLYour logo image (transparent PNG recommended, min 200px wide)
Accent ColorPrimary brand color — hex, e.g. #6366f1
Favicon URLBrowser tab icon
TaglineShort descriptor on the login/register page

✉️ SMTP / Email

FieldDescription
HostSMTP hostname (e.g. smtp.mailgun.org)
Port587 for TLS, 465 for SSL
Username / PasswordSMTP credentials
Encryptiontls or ssl
From NameSender name (e.g. Acme Giveaways)
From EmailSender address (e.g. no-reply@yourdomain.com)
⚠️ If SMTP is not configured, emails fall back to the platform's default mail server which may show Viraloo branding. Always set your own SMTP for a fully white-labeled experience.

💳 Stripe

Connect your own Stripe account so client subscription revenue goes directly to you.

FieldWhere to find it
Publishable KeyStripe Dashboard → Developers → API keys
Secret KeyStripe Dashboard → Developers → API keys
Webhook SecretStripe Dashboard → Webhooks → your endpoint → Signing secret

Stripe webhook setup:

  1. Stripe: Developers → Webhooks → Add endpoint
  2. Endpoint URL:
https://yourdomain.com/billing/webhook
  1. Events: checkout.session.completed, customer.subscription.*, invoice.*
  2. Copy the Signing secret → paste into the Webhook Secret field

📋 Email Templates

TemplateWhen sent
WelcomeNew client registers
Password ResetClient requests password reset
Campaign JoinedParticipant enters a campaign
Referral EarnedA referral generates a bonus entry
WinnerCampaign winner selected
Team InviteClient invites a collaborator
Double Opt-InOpt-in confirmation flow
UnsubscribedParticipant unsubscribes
Milestone AlertCampaign hits a participant milestone

Available template variables: {{name}} {{email}} {{campaign_title}} {{campaign_url}} {{brand_name}} {{referral_link}} {{winner_prize}}

🤖 Autoresponders

Connect an external ESP for clients to use with their campaigns — enabling automatic list-building when participants enter a giveaway. Configure credentials here so clients can link their own ESP accounts from their settings page.

WordPress Plugin for Clients

Walk clients through these steps to embed campaigns on WordPress:

  1. Download the plugin from their dashboard → Download Plugin
  2. WordPress: Plugins → Add New → Upload Plugin
  3. Go to Settings → Viraloo Campaigns
  4. Set Viraloo Site URL to your portal domain (e.g. https://yourdomain.com)
  5. Paste their Sync Token → Save → Sync Campaigns
💡 Clients must set your domain (not viraloo.org) as the site URL so API calls route to your installation.

Client Onboarding Checklist

Portal setup (one-time)

  • Configure Brand settings (name, logo, accent color, favicon)
  • Set up SMTP and send a test email
  • Connect Stripe and configure the webhook
  • Customize email templates with your brand name
  • Set up autoresponder integration if needed

Per new client

  • Create account via Portal Admin → Add Client
  • Assign the correct plan
  • Share login credentials securely
  • Send plugin download link and step-by-step setup instructions

Plans & Limits

Each client is assigned a plan controlling usage limits (max campaigns, participants per campaign, features). Plan tiers are set at the platform level by the super-admin. You can assign or change any client's plan at any time via the edit screen.

Support & Escalation

As a white-label holder, you are the first line of support for your clients. Escalate to Viraloo only for platform-level bugs, outages, or billing issues with your own Viraloo account.

Key URLs Reference

URLPurpose
/portal-adminPortal admin dashboard
/portal-admin/usersClient list
/portal-admin/campaignsAll client campaigns
/portal-admin/settingsPortal configuration
/registerClient self-registration (if enabled)
/billing/webhookStripe webhook endpoint
On this page
    Link copied