Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.omneo.io/llms.txt

Use this file to discover all available pages before exploring further.

The Omneo Corporate Invites extension provides a white-label sign-up portal for controlled partner acquisition flows — for example, inviting staff from a partner company to join a brand’s program, or running an exclusive invite-only member acquisition campaign.

​
How it works

  1. A prospect arrives at the corporate invite portal via a unique partner link
  2. Optionally, they enter a passcode to access the self-invite page
  3. They enter their email address and submit
  4. Optionally, their email domain is validated against a whitelist
  5. An invite link is sent to their email address
  6. They follow the link to complete their Omneo profile registration
  7. Tags and statuses configured for the partner are applied to their new profile

​
Configuration

Corporate Invite partners are configured as JSON in CX Manager under Settings → Plugins → Corporate Invites.

​
Partner configuration structure

{
  "partner-handle": {
    "name": "Partner Company Name",
    "whitelist": ["example.com", "partner.com"],
    "logo": {
      "mobile": { "url": "https://...", "height": 32 },
      "desktop": { "url": "https://...", "height": 44 }
    },
    "passcode": {
      "title": "Enter your access code",
      "enabled": true
    },
    "landing": {
      "title": "You're invited to join Brand Name",
      "subtitle": "Sign up using your company email to access exclusive benefits."
    },
    "success": {
      "redirect": {
        "url": "https://www.brand.com/",
        "timeout": 10,
        "title": "You'll be redirected to brand.com"
      }
    },
    "secure": {
      "passcode": "1234",
      "invite": {
        "invite_definition_id": 12,
        "meta": {
          "tags": ["partner-staff"],
          "statuses": ["partner_member"]
        }
      },
      "email": {
        "logo": {
          "url": "https://...",
          "width_mobile": 180,
          "width_desktop": 180
        }
      }
    }
  }
}

​
Key configuration fields

FieldDescription
partner-handleURL-friendly slug used in the invite link
nameDisplay name shown to the end user
whitelistArray of allowed email domains. Set to false to allow all domains
passcode.enabledShow a passcode entry page before the invite form
secure.passcodeThe actual passcode value (stored server-side only)
invite_definition_idOmneo invite definition to use for this partner
meta.tagsTags applied to profiles created through this portal
meta.statusesStatuses applied to profiles created through this portal

​
Portal URL structure

The invite portal URL follows this pattern: 
https://invites.getomneo.com/{partner-handle}

​
Cache refresh

After updating the configuration, refresh the cache: 
https://omneo-corporate-invites.appspot.com/api/config/refresh
Or if using a custom domain: 
https://partners.your-domain.com/api/config/refresh
Changes take effect immediately after cache refresh. Without a manual refresh, the cache expires after 24 hours.

​
Email merge fields

The invitation email sent to prospects has access to the following merge fields: 
{
  "partner_name": "Partner Company Name",
  "partner_handle": "partner-handle",
  "logo": { "url": "...", "width_desktop": 180, "width_mobile": 180 },
  "domain": "https://invites.getomneo.com"
}