Activation (Public)

The activation resource provides a public, unauthenticated read of an activation pack. It is used by activation microsites and smart links to render a branded launch page for a genie or portal without exposing any internal data.

This endpoint requires no authentication. The pack UUID is the only credential — sharing a pack UUID is the owner’s signal to distribute it publicly.

Get public activation

Returns a sanitized, whitelisted activation object for the given pack ID. Includes branding, channel links, and a short promotional tagline derived from the pack’s promotional copy. The target genie or portal must still exist. If the target has been deleted, the request returns 404.

string

required

activation

string

required

public-get

string

required

The activation pack UUID.

object

The public activation object.

Show properties

string

The activation pack UUID.

string

Display name derived from the linked genie or portal.

string | null

Brand tagline from the linked genie or portal branding, if set.

null

Always null. Internal descriptions are never exposed publicly.

string

Either "genie" or "portal", indicating what type of resource this pack is linked to.

string

The URL where the genie or portal can be accessed. Constructed from the request origin and the genie’s public URL slug or portal slug.

object

Resolved branding configuration. Pack overrides take precedence over the linked target’s branding.

Show properties

string

Primary brand color (hex). Defaults to "#4E9CFF".

string | null

Secondary brand color (hex), or null if not set.

string | null

Logo image URL, or null if not set.

string | null

Brand display name, or null if not set.

boolean

Whether to render a gradient background.

number | null

Gradient angle in degrees, or null if not set.

object[]

Distribution channels enabled for this pack, as ready-to-use link objects.

Show item properties

string

Channel type. One of web_widget, phone, sms, whatsapp.

string

Human-readable label (for example "Call", "Chat on the web").

string

Action URL for this channel (for example "tel:+15551234567", "sms:+15551234567", a WhatsApp deep link, or the genie page URL for web widget).

A short promotional line from the pack’s website banner copy (maximum 200 characters). Sourced from the punchy tone first, then friendly. null if no banner copy has been generated yet.

const response = await ApiService.invoke({
  resource: "activation",
  action: "public-get",
  id: "pack-uuid",
});

curl -X POST https://api.helpgenie.ai/v1/activation \
  -H "Content-Type: application/json" \
  -d '{
    "action": "public-get",
    "id": "pack-uuid"
  }'

{
  "success": true,
  "data": {
    "activation": {
      "id": "pack-uuid",
      "name": "Customer Support",
      "tagline": "Always on. Always helpful.",
      "description": null,
      "targetType": "genie",
      "targetUrl": "https://mycompany.com/live-agent/customer-support",
      "branding": {
        "primaryColor": "#4E9CFF",
        "secondaryColor": null,
        "logoUrl": "https://storage.helpgenie.ai/logos/mycompany.png",
        "brandName": "MyCompany",
        "gradientEnabled": true,
        "gradientAngle": 135
      },
      "channels": [
        {
          "type": "web_widget",
          "label": "Chat on the web",
          "url": "https://mycompany.com/live-agent/customer-support"
        },
        {
          "type": "phone",
          "label": "Call",
          "url": "tel:+15551234567"
        }
      ],
      "promoTagline": "Get answers instantly — no hold music."
    }
  }
}

Error responses

Status	Code	Description
400	`VALIDATION_ERROR`	Pack ID is missing
404	`NOT_FOUND`	Pack not found, or the linked genie/portal has been deleted
500	`INTERNAL_ERROR`	Server error

Overview

Public (unauthenticated)

Agents

Knowledge

CRM

Marketplace

Platform

Telephony

Worker genies

Quality & Compliance

Access Control

Intelligence

Education

Voice

Integrations

Expanded Platform

Get public activation

Error responses

​Get public activation

​Error responses

Get public activation

Error responses