Activation Packs

Activation packs tie a genie or portal to a collection of launch assets: channel configuration, branding overrides, promotional copy, and generated marketing materials. When a pack is created, promotional copy for all templates is automatically generated in the background.

Standard users can only access their own activation packs. Admin users can access any user’s packs by passing adminMode: true and userId.

List activation packs

Returns a paginated list of activation packs for the authenticated user.

string

required

activation-packs

string

required

list

object

Show properties

string

Filter to packs linked to a specific genie.

string

Filter to packs linked to a specific portal.

number

default:"50"

Results per page. Maximum 500.

number

default:"0"

Number of results to skip.

boolean

Admin only. Access packs belonging to another user.

string

Admin only. Target user ID when using adminMode.

ActivationPack[]

Array of activation pack objects. See the get action for the full object shape.

number

Total number of matching packs.

number

The limit that was applied.

number

The offset that was applied.

const response = await ApiService.invoke({
  resource: "activation-packs",
  action: "list",
  data: {
    agent_id: "genie-uuid",
    limit: 20,
    offset: 0,
  },
});

curl -X POST https://api.helpgenie.ai/v1/activation-packs \
  -H "Authorization: Bearer hg_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "action": "list",
    "data": {
      "agent_id": "genie-uuid",
      "limit": 20,
      "offset": 0
    }
  }'

Get activation pack

Retrieves a single activation pack by ID, including nested genie and portal data.

string

required

activation-packs

string

required

get

string

required

The activation pack UUID.

object

Show properties

boolean

Admin only. Fetch a pack owned by another user.

string

Admin only. Target user ID when using adminMode.

object

Show properties

string

Pack UUID.

string

Pack name.

string | null

Pack description.

string | null

Linked genie UUID, or null if linked to a portal.

string | null

Linked portal UUID, or null if linked to a genie.

object

Enabled distribution channels. Boolean flags for web_widget, phone, sms, whatsapp, and similar channels.

object | null

Optional branding overrides applied on top of the linked genie or portal branding.

object | null

Configuration for generated marketing assets (QR codes, banners, etc.).

object | null

Results of the most recent asset generation run.

Generated promotional copy, keyed by template then tone. For example promo_content.launch_email.friendly.body.

object | null

Distribution touchpoint configuration.

string

ISO 8601 creation timestamp.

string

ISO 8601 last-updated timestamp.

object | null

Nested genie data, present when agent_id is set.

Show properties

string

Genie ID.

string

Genie name.

object | null

Genie branding configuration.

object | null

Public page info. Contains url_name.

object | null

Phone number info. Contains phone_number.

object | null

Nested portal data, present when portal_id is set.

Show properties

string

Portal ID.

string

Portal name.

string

Portal URL slug.

object | null

Portal branding configuration.

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

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

Create activation pack

Creates a new activation pack linked to a genie or portal. After creation, promotional copy for all templates is generated automatically in the background.

string

required

activation-packs

string

required

create

object

required

Show properties

string

required

Pack display name.

string

Link this pack to a specific genie. Either agent_id or portal_id should be provided.

string

Link this pack to a specific portal. Either agent_id or portal_id should be provided.

string

Pack description.

object

Distribution channel flags. For example { "web_widget": true, "phone": false }.

object

Branding values that override the linked genie or portal branding.

object

Configuration for marketing asset generation.

object

Distribution touchpoint configuration.

string

Base URL used when generating promotional copy. Defaults to "https://helpgenie.ai". Not persisted to the pack.

boolean

Admin only. Create on behalf of another user.

string

Admin only. Target user ID when using adminMode.

object

The newly created pack. See the get action for the full object shape.

const response = await ApiService.invoke({
  resource: "activation-packs",
  action: "create",
  data: {
    name: "Summer Launch",
    agent_id: "genie-uuid",
    description: "Launch pack for our summer campaign",
    channels: {
      web_widget: true,
      phone: true,
      sms: false,
    },
    baseUrl: "https://mycompany.com",
  },
});

curl -X POST https://api.helpgenie.ai/v1/activation-packs \
  -H "Authorization: Bearer hg_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "action": "create",
    "data": {
      "name": "Summer Launch",
      "agent_id": "genie-uuid",
      "channels": { "web_widget": true, "phone": true },
      "baseUrl": "https://mycompany.com"
    }
  }'

Creating a pack triggers background generation of promotional copy for all five templates at their default tones. By the time you navigate to the pack detail, copy is usually ready.

Update activation pack

Updates fields on an existing activation pack. Only provided fields are written; omitted fields remain unchanged.

string

required

activation-packs

string

required

update

string

required

The activation pack UUID.

object

required

Show properties

string

Updated pack name.

string

Updated description.

string

Link to a different genie.

string

Link to a different portal.

object

Updated channel flags.

object

Updated branding overrides.

object

Updated asset configuration.

object

Updated touchpoints.

Updated promo content map.

boolean

Admin only.

string

Admin only. Target user ID.

object

The updated pack object.

const response = await ApiService.invoke({
  resource: "activation-packs",
  action: "update",
  id: "pack-uuid",
  data: {
    name: "Summer Launch v2",
    channels: { web_widget: true, phone: true, sms: true },
  },
});

curl -X POST https://api.helpgenie.ai/v1/activation-packs \
  -H "Authorization: Bearer hg_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "action": "update",
    "id": "pack-uuid",
    "data": {
      "name": "Summer Launch v2",
      "channels": { "web_widget": true, "phone": true, "sms": true }
    }
  }'

Delete activation pack

Permanently deletes an activation pack.

string

required

activation-packs

string

required

delete

string

required

The activation pack UUID.

object

Show properties

boolean

Admin only.

string

Admin only. Target user ID.

boolean

true when the pack was deleted.

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

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

This action is permanent and cannot be undone.

Generate assets

Triggers the asset generation workflow for an activation pack (QR codes, banners, and other visual materials). The actual generation is performed client-side by the asset generation workflow after this endpoint confirms the pack exists.

string

required

activation-packs

string

required

generate-assets

string

required

The activation pack UUID.

object

Show properties

boolean

Admin only.

string

Admin only. Target user ID.

boolean

true when the pack was found and the asset generation signal was sent.

string

Confirmation message.

string

The pack ID that should receive the generated assets.

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

curl -X POST https://api.helpgenie.ai/v1/activation-packs \
  -H "Authorization: Bearer hg_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "action": "generate-assets",
    "id": "pack-uuid"
  }'

Generate promotional copy

Generates a single piece of promotional copy for an activation pack and persists it to the pack’s promo_content field. Use this to regenerate a specific template/tone combination on demand.

string

required

activation-packs

string

required

generate-promo

string

required

The activation pack UUID.

object

required

Show properties

string

required

The promotional template to generate. One of:

launch_email — 90–140 word customer-facing launch email body
social_post — LinkedIn-ready post (70–110 words)
customer_sms — SMS message (160 characters or fewer)
team_announcement — Internal staff announcement (100–160 words)
website_banner — Two-line homepage banner headline + supporting copy

string

Copy tone. One of professional, friendly, punchy. Default varies by template (friendly for most, professional for team announcements, punchy for banners).

string

URL included in the generated copy for readers to act on. Defaults to "https://helpgenie.ai".

boolean

Admin only.

string

Admin only. Target user ID.

string

The template that was generated.

string

The tone that was used.

object

The generated copy.

Show properties

string

The main copy body.

string

Email subject line. Present only for launch_email and team_announcement templates.

string

ISO 8601 timestamp of when the copy was generated.

const response = await ApiService.invoke({
  resource: "activation-packs",
  action: "generate-promo",
  id: "pack-uuid",
  data: {
    template: "launch_email",
    tone: "friendly",
    targetUrl: "https://mycompany.com/chat",
  },
});

curl -X POST https://api.helpgenie.ai/v1/activation-packs \
  -H "Authorization: Bearer hg_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "action": "generate-promo",
    "id": "pack-uuid",
    "data": {
      "template": "launch_email",
      "tone": "friendly",
      "targetUrl": "https://mycompany.com/chat"
    }
  }'

{
  "success": true,
  "data": {
    "template": "launch_email",
    "tone": "friendly",
    "content": {
      "subject": "Say hello to our new smart assistant",
      "body": "We have some exciting news to share. We have just launched a new assistant that is available 24/7 to answer your questions about our products and services...",
      "generated_at": "2024-06-26T10:00:00.000Z"
    }
  }
}

Generated copy is automatically persisted to the pack’s promo_content field under promo_content[template][tone]. Subsequent requests for the same template/tone overwrite the stored copy.

Error responses

Status	Code	Description
400	`VALIDATION_ERROR`	Missing required fields (e.g. pack ID, template)
403	`FORBIDDEN`	Non-admin user attempted to target another user
404	`NOT_FOUND`	Activation pack not found
500	`INTERNAL_ERROR`	Server error, including copy generation failure

Overview

Public (unauthenticated)

Agents

Knowledge

CRM

Marketplace

Platform

Telephony

Worker genies

Quality & Compliance

Access Control

Intelligence

Education

Voice

Integrations

Expanded Platform

List activation packs

Get activation pack

Create activation pack

Update activation pack

Delete activation pack

Generate assets

Generate promotional copy

Error responses

​List activation packs

​Get activation pack

​Create activation pack

​Update activation pack

​Delete activation pack

​Generate assets

​Generate promotional copy

​Error responses

List activation packs

Get activation pack

Create activation pack

Update activation pack

Delete activation pack

Generate assets

Generate promotional copy

Error responses