FastComments JavaScript/TypeScript SDK

This is the official JavaScript/TypeScript SDK for FastComments.

Manage comments, users, SSO, and moderation from Node.js or the browser.

Repository

Installation

npm install fastcomments-sdk

API Documentation

Full API reference: docs/api/README.md

Browser vs Server Compatibility

This SDK uses dual entry points to ensure optimal compatibility and prevent runtime errors:

fastcomments-sdk/browser - Browser-safe version with native fetch
fastcomments-sdk/server - Full Node.js version with SSO support
fastcomments-sdk (default) - Types only, safe to import anywhere

Usage

This SDK provides separate entry points for browser and server environments to ensure optimal compatibility and security:

Browser Usage (Client-Side)

For browser/frontend applications, use the browser-safe export that excludes Node.js dependencies:

// Browser-safe import (no Node.js dependencies)
import { createFastCommentsBrowserSDK } from 'fastcomments-sdk/browser';

// Create browser SDK instance
const sdk = createFastCommentsBrowserSDK({
  basePath: 'https://fastcomments.com' // optional, defaults to https://fastcomments.com
});

// Use public APIs (no API key needed - safe for browsers)
const comments = await sdk.publicApi.getCommentsPublic({ 
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Server Usage (Node.js)

For server/backend applications, use the full SDK with SSO and authentication features:

// Server-side import (includes SSO and designed to work with NodeJS)
import { createFastCommentsSDK } from 'fastcomments-sdk/server';

// Create server SDK instance
const sdk = createFastCommentsSDK({
  apiKey: 'your-api-key', // Keep this secret on the server!
  basePath: 'https://fastcomments.com' // optional, defaults to https://fastcomments.com
});

// Use secured APIs with your API key
const comments = await sdk.defaultApi.getComments({ 
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Types Only Import

If you only need TypeScript types (no runtime code), use the default import:

// Types only (no runtime dependencies - safe everywhere)
import type { 
  PublicComment, 
  CreateCommentParams, 
  GetCommentsPublic200Response 
} from 'fastcomments-sdk';

Using Individual API Classes

Browser Environment

import { PublicApi, Configuration } from 'fastcomments-sdk/browser';

const config = new Configuration({
  basePath: 'https://fastcomments.com'
});

const publicApi = new PublicApi(config);

Server Environment

import { DefaultApi, PublicApi, Configuration } from 'fastcomments-sdk/server';

const config = new Configuration({
  apiKey: 'your-api-key',
  basePath: 'https://fastcomments.com'
});

const defaultApi = new DefaultApi(config);
const publicApi = new PublicApi(config);

Public vs Secured APIs

The SDK provides three main API classes:

DefaultApi - Secured endpoints that require your API key for authentication. Use these for server-side operations.
PublicApi - Public endpoints that can be accessed without an API key. These can be called directly from browsers/mobile devices/etc.
HiddenApi - Internal/admin endpoints for advanced use cases.

Example: Using Public API (browser-safe)

import { PublicApi } from 'fastcomments-sdk/browser';

const publicApi = new PublicApi();

// Get comments for a page (no API key required)
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Example: Using Default API (server-side only)

import { DefaultApi, Configuration } from 'fastcomments-sdk/server';

const config = new Configuration({
  apiKey: 'your-api-key' // Keep this secret!
});
const defaultApi = new DefaultApi(config);

// Get comments with full admin access
const response = await defaultApi.getComments({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

SSO (Single Sign-On) Integration

FastComments supports SSO to integrate with your existing user authentication system. SSO functionality is only available in the server export since it requires Node.js crypto features.

Simple SSO (Server-Side Only)

Simple SSO should be generated server-side and sent to the client:

// Server-side code (Node.js/backend)
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

// Create simple SSO using the built-in helper  
const userData = {
  username: 'john_doe',
  email: 'john@example.com',
  displayName: 'John Doe',
  avatar: 'https://example.com/avatar.jpg'
};

const sso = FastCommentsSSO.createSimple(userData, {
  loginURL: '/login',
  logoutURL: '/logout'
});

const ssoToken = sso.createToken();

// Send ssoToken to your client-side code
// Client-side code can then use this token with the browser SDK

Secure SSO (Server-Side, Recommended)

Secure SSO should be implemented server-side and provides better security:

// Server-side code (Node.js/backend)
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

// Create secure SSO using the built-in helper
const userData = {
  id: 'user-123',
  email: 'john@example.com',
  username: 'john_doe',
  displayName: 'John Doe',
  avatar: 'https://example.com/avatar.jpg',
  isAdmin: false,
  isModerator: false
};

const sso = FastCommentsSSO.createSecure('your-api-key', userData, {
  loginURL: '/login',
  logoutURL: '/logout'
});

const ssoConfig = sso.prepareToSend();

// Use with API calls on the server
const publicApi = new PublicApi();
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
  sso: JSON.stringify(ssoConfig)
});

// Or send ssoConfig to client for browser usage

Using SSO from Browser (with Server-Generated Token)

// Client-side code (browser)
import { PublicApi } from 'fastcomments-sdk/browser';

// Get SSO token from your server endpoint
const ssoToken = await fetch('/api/sso-token').then(r => r.json());

const publicApi = new PublicApi();
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
  sso: ssoToken // Use the server-generated SSO token
});

SSO with Comment Creation

// Server-side: Create SSO and comment
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

const sso = FastCommentsSSO.createSecure('your-api-key', userData);
const ssoConfig = sso.prepareToSend();

const response = await publicApi.createCommentPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
  broadcastId: 'unique-broadcast-id',
  commentData: {
    comment: 'This is my comment',
    date: Date.now(),
    commenterName: 'John Doe',
    url: 'https://example.com/page',
    urlId: 'page-url-id'
  },
  sso: JSON.stringify(ssoConfig)
});

Common Use Cases

Getting Comments for a Page

const comments = await sdk.publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'article-123'
});

Creating a Comment

const newComment = await sdk.publicApi.createCommentPublic({
  createCommentParams: {
    tenantId: 'your-tenant-id',
    urlId: 'article-123',
    comment: 'Great article!',
    commenterName: 'John Doe',
    commenterEmail: 'john@example.com'
  }
});

Voting on a Comment

const voteResponse = await sdk.publicApi.voteComment({
  voteBodyParams: {
    commentId: 'comment-id',
    direction: 1 // 1 for upvote, -1 for downvote
  }
});

User Management (Requires API Key)

// Search for users (requires DefaultApi)
const users = await sdk.defaultApi.searchUsers({
  tenantId: 'your-tenant-id',
  urlId: 'page-id',
  usernameStartsWith: 'john'
});

Live Events (Real-time Updates)

Subscribe to live events to get real-time updates for comments, votes, and other activities.

Page-Level Events

Listen for live events on a specific page (comments, votes, etc.):

import { subscribeToChanges, LiveEvent, LiveEventType } from 'fastcomments-sdk/browser';

const config = {
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
};

// Subscribe to live events for a page
const subscription = subscribeToChanges(
  config,
  'your-tenant-id', // tenantIdWS
  'page-url-id',    // urlIdWS  
  'user-session-id', // userIdWS (get this from getComments response)
  (event: LiveEvent) => {
    console.log('Live event received:', event);
    
    switch (event.type) {
      case LiveEventType.new_comment:
        console.log('New comment:', event.comment);
        // Update your UI with the new comment
        break;
      case LiveEventType.new_vote:
        console.log('New vote:', event.vote);
        // Update vote counts in your UI
        break;
      case LiveEventType.updated_comment:
        console.log('Comment updated:', event.comment);
        break;
      default:
        console.log('Other event type:', event.type);
    }
    
    return true; // Return true if event was handled
  },
  (isConnected: boolean) => {
    console.log('Connection status:', isConnected ? 'Connected' : 'Disconnected');
  }
);

// Close the subscription when done
subscription.close();

Listen for user-specific events (notifications, mentions, etc.):

import { subscribeToUserFeed, LiveEvent, LiveEventType } from 'fastcomments-sdk/browser';

const userConfig = {
  userIdWS: 'user-session-id', // Get this from getComments response
};

// Subscribe to user's personal feed
const userSubscription = subscribeToUserFeed(
  userConfig,
  (event: LiveEvent) => {
    console.log('User event received:', event);
    
    switch (event.type) {
      case LiveEventType.notification:
        console.log('New notification:', event.notification);
        // Show notification in your UI
        break;
      case LiveEventType.notification_update:
        console.log('Notification updated:', event.notification);
        break;
      default:
        console.log('Other user event:', event.type);
    }
    
    return true;
  },
  (isConnected: boolean) => {
    console.log('User feed connection:', isConnected ? 'Connected' : 'Disconnected');
  }
);

// Close when done
userSubscription.close();

Getting userIdWS

The userIdWS parameter is required for live events and can be obtained from API responses:

const response = await sdk.publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-id'
});

// Extract userIdWS from the response
const userIdWS = response.data?.userSessionInfo?.userIdWS;

if (userIdWS) {
  // Now you can subscribe to live events
  const subscription = subscribeToChanges(config, tenantIdWS, urlIdWS, userIdWS, handleEvent);
}

Broadcast IDs

You'll see you're supposed to pass a broadcastId in some API calls. When you receive events, you'll get this ID back, so you know to ignore the event if you plan to optimistically apply changes on the client (which you'll probably want to do since it offers the best experience). Pass a UUID here. The ID should be unique enough to not occur twice in a browser session.

import { v4 as uuidv4 } from 'uuid';

const response = await sdk.publicApi.createCommentPublic({
  createCommentParams: {
    tenantId: 'your-tenant-id',
    urlId: 'page-id',
    comment: 'My comment',
    broadcastId: uuidv4() // Unique ID for this operation
  }
});

Error Handling

try {
  const comments = await sdk.publicApi.getCommentsPublic({
    tenantId: 'your-tenant-id',
    urlId: 'page-id'
  });
} catch (error) {
  if (error.response?.status === 404) {
    console.log('Page not found');
  } else {
    console.error('API Error:', error.message);
  }
}

aggregate

Aggregates documents by grouping them (if groupBy is provided) and applying multiple operations. Different operations (e.g. sum, countDistinct, avg, etc.) are supported.

Parameters

Name	Type	Required
tenantId	string	Yes
aggregationRequest	AggregationRequest	Yes
parentTenantId	string	No
includeStats	boolean	No

Response

Returns: AggregationResponse

Example

aggregate Example

Copy

const tenantId: string = "acme_corp_123";
const parentTenantId: string = "global_acme_1";
const includeStats: boolean = true;
const predicateValue: QueryPredicateValue = { stringValue: "active" };
const predicate: QueryPredicate = { field: "status", operator: "EQ", value: predicateValue };
const operation: AggregationOperation = { type: "COUNT", field: "id", alias: "total" };
const sort: AggregationRequestSort = { field: "total", direction: "DESC" };
const aggregationRequest: AggregationRequest = {
  query: { predicates: [predicate] },
  operations: [operation],
  sort: [sort],
  limit: 100
};
const response: AggregationResponse = await aggregate(tenantId, aggregationRequest, parentTenantId, includeStats);

getAuditLogs

Parameters

Name	Type	Required
tenantId	string	Yes
limit	number	No
skip	number	No
order	SORTDIR	No
after	number	No
before	number	No

Response

Returns: GetAuditLogs200Response

Example

getAuditLogs Example

Copy

const tenantId: string = 'tenant_9f1b3c';
const limit: number = 50;
const skip: number = 0;
const order: SORTDIR = SORTDIR.DESC;
const after: number = Date.now() - 1000 * 60 * 60 * 24;
const before: number = Date.now();
const response: GetAuditLogs200Response = await getAuditLogs(tenantId, limit, skip, order, after, before);

blockFromCommentPublic

Parameters

Name	Type	Required
tenantId	string	Yes
commentId	string	Yes
publicBlockFromCommentParams	PublicBlockFromCommentParams	Yes
sso	string	No

Response

Returns: BlockFromCommentPublic200Response

Example

blockFromCommentPublic Example

Copy

const tenantId: string = 'tenant_6f1a2b9c';
const commentId: string = 'comment_b3d92f47';
const publicBlockFromCommentParams: PublicBlockFromCommentParams = {
  reason: 'abusive language',
  durationMinutes: 1440,
  notifyAuthor: false
};
const sso: string = 'sso_tok_eyJhbGciOiJIUzI1Ni';
const result: BlockFromCommentPublic200Response = await blockFromCommentPublic(tenantId, commentId, publicBlockFromCommentParams, sso);

unBlockCommentPublic

Parameters

Name	Type	Required
tenantId	string	Yes
commentId	string	Yes
publicBlockFromCommentParams	PublicBlockFromCommentParams	Yes
sso	string	No

Response

Returns: UnBlockCommentPublic200Response

Example

unBlockCommentPublic Example

Copy

const tenantId: string = 'tenant_acme_corp_001';
const commentId: string = 'comment_20260519_334';
const publicBlockFromCommentParams: PublicBlockFromCommentParams = {
  reason: 'User appeal approved',
  clearedBy: 'moderator.alice',
  clearedAt: new Date().toISOString()
} as PublicBlockFromCommentParams;
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sso-sample-token';
const result: UnBlockCommentPublic200Response = await unBlockCommentPublic(tenantId, commentId, publicBlockFromCommentParams, sso);

checkedCommentsForBlocked

Parameters

Name	Type	Required
tenantId	string	Yes
commentIds	string	Yes
sso	string	No

Response

Returns: CheckedCommentsForBlocked200Response

Example

checkedCommentsForBlocked Example

Copy

const tenantId: string = "acme-corp-00042";
const commentIds: string = "cmt-1001,cmt-1002";
const ssoToken: string = "sso_jwt_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9";
const checkedWithSso: CheckedCommentsForBlocked200Response = await checkedCommentsForBlocked(tenantId, commentIds, ssoToken);
const checkedWithoutSso: CheckedCommentsForBlocked200Response = await checkedCommentsForBlocked(tenantId, commentIds);

blockUserFromComment

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	Yes
blockFromCommentParams	BlockFromCommentParams	Yes
userId	string	No
anonUserId	string	No

Response

Returns: BlockFromCommentPublic200Response

Example

blockUserFromComment Example

Copy

const tenantId: string = 'tenant_abc123';
const commentId: string = 'comment_98765';
const blockFromCommentParams: BlockFromCommentParams = { reason: 'abusive_language', durationDays: 30 };
const userId: string = 'user_42';
const result: BlockFromCommentPublic200Response = await blockUserFromComment(tenantId, commentId, blockFromCommentParams, userId);

createCommentPublic

Parameters

Name	Type	Required
tenantId	string	Yes
urlId	string	Yes
broadcastId	string	Yes
commentData	CommentData	Yes
sessionId	string	No
sso	string	No

Response

Returns: CreateCommentPublic200Response

Example

createCommentPublic Example

Copy

const tenantId: string = 'tenant_9812';
const urlId: string = 'prod-launch-20260520';
const broadcastId: string = 'broadcast_20260520_01';
const commentData: CommentData = {
  content: 'Amazing launch — congrats to the whole team!',
  authorName: 'Alex Morgan',
  mentions: [] as CommentUserMentionInfo[],
  hashtags: [] as CommentUserHashTagInfo[]
};
const sessionId: string | undefined = 'sess_9f7b3c';
const sso: string | undefined = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
const result: CreateCommentPublic200Response = await createCommentPublic(tenantId, urlId, broadcastId, commentData, sessionId, sso);

deleteComment

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	Yes
contextUserId	string	No
isLive	boolean	No

Response

Returns: DeleteComment200Response

Example

deleteComment Example

Copy

(async () => {
  const tenantId: string = 'tenant_8b3f21';
  const id: string = 'comment_52a9c';
  const contextUserId: string = 'user_3f1d2';
  const isLive: boolean = true;
  const result: DeleteComment200Response = await deleteComment(tenantId, id, contextUserId, isLive);
  console.log(result);
})();

deleteCommentPublic

Parameters

Name	Type	Required
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	Yes
editKey	string	No
sso	string	No

Response

Returns: DeleteCommentPublic200Response

Example

deleteCommentPublic Example

Copy

const tenantId: string = 'tenant_98765';
const commentId: string = 'cmt_4521';
const broadcastId: string = 'broadcast_live_01';
const editKey: string = 'edit_3a2b'; // optional
const sso: string = 'sso_token_abcd1234'; // optional
const result: DeleteCommentPublic200Response = await deleteCommentPublic(tenantId, commentId, broadcastId, editKey, sso);

deleteCommentVote

Parameters

Name	Type	Required
tenantId	string	Yes
commentId	string	Yes
voteId	string	Yes
urlId	string	Yes
broadcastId	string	Yes
editKey	string	No
sso	string	No

Response

Returns: DeleteCommentVote200Response

Example

deleteCommentVote Example

Copy

const tenantId: string = 'tenant_4b2f9';
const commentId: string = 'cmt_921f3';
const voteId: string = 'vote_3a8b1';
const urlId: string = 'https://news.site/articles/2026/05/20/launch';
const broadcastId: string = 'broadcast_20260520_01';
const editKey: string = 'editkey_7d2c';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.ssoPayload.signature';
const result: DeleteCommentVote200Response = await deleteCommentVote(tenantId, commentId, voteId, urlId, broadcastId, editKey, sso);

flagComment

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	Yes
userId	string	No
anonUserId	string	No

Response

Returns: FlagComment200Response

Example

flagComment Example

Copy

const tenantId: string = 'tenant_8a3f';
const id: string = 'cmt_b7f9e2';
const userId: string = 'user_1024';
const result: FlagComment200Response = await flagComment(tenantId, id, userId);

getComment

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

Response

Returns: GetComment200Response

Example

getComment Example

Copy

const tenantId: string = 'acme-corp-42';
const id: string = 'e7b6f3a2-4d1a-4b9e-9a2f-1c3d4e5f6a7b';
const includeDeleted: boolean | undefined = undefined;
const result: GetComment200Response = await getComment(tenantId, id);

getComments

Parameters

Name	Type	Required
tenantId	string	Yes
page	number	No
limit	number	No
skip	number	No
asTree	boolean	No
skipChildren	number	No
limitChildren	number	No
maxTreeDepth	number	No
urlId	string	No
userId	string	No
anonUserId	string	No
contextUserId	string	No
hashTag	string	No
parentId	string	No
direction	SortDirections	No

Response

Returns: GetComments200Response

Example

getComments Example

Copy

const tenantId: string = "tenant_5f2b9a";
const page: number = 1;
const limit: number = 20;
const asTree: boolean = true;
const maxTreeDepth: number = 2;
const urlId: string = "news/2026/05/20/new-feature";
const userId: string = "user_8d34";
const result: GetComments200Response = await getComments(
  tenantId,
  page,
  limit,
  undefined,
  asTree,
  undefined,
  undefined,
  maxTreeDepth,
  urlId,
  userId
);

getCommentsPublic

req tenantId urlId

Parameters

Name	Type	Required
tenantId	string	Yes
urlId	string	Yes
page	number	No
direction	SortDirections	No
sso	string	No
skip	number	No
skipChildren	number	No
limit	number	No
limitChildren	number	No
countChildren	boolean	No
fetchPageForCommentId	string	No
includeConfig	boolean	No
countAll	boolean	No
includei10n	boolean	No
locale	string	No
modules	string	No
isCrawler	boolean	No
includeNotificationCount	boolean	No
asTree	boolean	No
maxTreeDepth	number	No
useFullTranslationIds	boolean	No
parentId	string	No
searchText	string	No
hashTags	Array	No
userId	string	No
customConfigStr	string	No
afterCommentId	string	No
beforeCommentId	string	No

Response

Returns: GetCommentsPublic200Response

Example

getCommentsPublic Example

Copy

const tenantId: string = 'acme-corp';
const urlId: string = '/news/2026/product-launch';
const result: GetCommentsPublic200Response = await getCommentsPublic(
  tenantId,
  urlId,
  1,
  undefined,
  'sso_jwt_123456',
  0,
  0,
  25,
  5,
  true,
  undefined,
  true,
  false,
  true,
  'en-US',
  'comments,likes',
  false,
  true,
  true,
  3,
  false,
  undefined,
  'great product',
  ['product', 'launch'],
  'user_98765',
  undefined,
  undefined,
  undefined
);

getCommentText

Parameters

Name	Type	Required
tenantId	string	Yes
commentId	string	Yes
editKey	string	No
sso	string	No

Response

Returns: GetCommentText200Response

Example

getCommentText Example

Copy

const tenantId: string = 'acme-corp-01';
const commentId: string = 'cmt_987654321';
const editKey: string = 'edk_abc123def';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
const resultWithOptional: GetCommentText200Response = await getCommentText(tenantId, commentId, editKey, sso);
const resultRequiredOnly: GetCommentText200Response = await getCommentText(tenantId, commentId);

getCommentVoteUserNames

Parameters

Name	Type	Required
tenantId	string	Yes
commentId	string	Yes
dir	number	Yes
sso	string	No

Response

Returns: GetCommentVoteUserNames200Response

Example

getCommentVoteUserNames Example

Copy

const tenantId: string = 'tenant_7f4b3d2a';
const commentId: string = 'cmt_9a8b7c6d';
const dir: number = -1;
const ssoToken: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature';
const resultWithSSO: GetCommentVoteUserNames200Response = await getCommentVoteUserNames(tenantId, commentId, dir, ssoToken);
const resultWithoutSSO: GetCommentVoteUserNames200Response = await getCommentVoteUserNames(tenantId, commentId, dir);

lockComment

Parameters

Name	Type	Required
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	Yes
sso	string	No

Response

Returns: LockComment200Response

Example

lockComment Example

Copy

const tenantId: string = 'tenant_12345'
const commentId: string = 'comment-9b2d'
const broadcastId: string = 'broadcast-20260520-01'
const sso: string = 'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ1c2VyX2lkMTIzIn0.D4kR7ZxVb3NqZ1xY'
const responseWithSso: LockComment200Response = await lockComment(tenantId, commentId, broadcastId, sso)
const responseWithoutSso: LockComment200Response = await lockComment(tenantId, commentId, broadcastId)

pinComment

Parameters

Name	Type	Required
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	Yes
sso	string	No

Response

Returns: PinComment200Response

Example

pinComment Example

Copy

const tenantId: string = 'tenant_4472';
const commentId: string = 'cmt_8a9f3b';
const broadcastId: string = 'broadcast_2026-05-20_01';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIn0.signature';
const result: PinComment200Response = await pinComment(tenantId, commentId, broadcastId, sso);

saveComment

Parameters

Name	Type	Required
tenantId	string	Yes
createCommentParams	CreateCommentParams	Yes
isLive	boolean	No
doSpamCheck	boolean	No
sendEmails	boolean	No
populateNotifications	boolean	No

Response

Returns: SaveComment200Response

Example

saveComment Example

Copy

const tenantId: string = "acme-tenant-17";
const createCommentParams: CreateCommentParams = {
  body: "Thanks — this clarified the deployment. Suggest adding a note about step 3.",
  authorId: "user_789",
  threadId: "article_342",
  clientCreatedAt: new Date().toISOString()
};
const saveResult: SaveComment200Response = await saveComment(tenantId, createCommentParams, true, false, true, true);

saveCommentsBulk

Parameters

Name	Type	Required
tenantId	string	Yes
createCommentParams	Array	Yes
isLive	boolean	No
doSpamCheck	boolean	No
sendEmails	boolean	No
populateNotifications	boolean	No

Response

Returns: Array<SaveComment200Response

Example

saveCommentsBulk Example

Copy

const tenantId: string = "tenant_12345";
const createParams: CreateCommentParams[] = [
  {
    content: "Finished the draft for the Q2 report, please review.",
    authorId: "user_789",
    mentions: [{ userId: "user_456", startIndex: 34, length: 4 } as CommentUserMentionInfo],
    hashtags: [{ tag: "Q2", indices: [28, 30] } as CommentUserHashTagInfo]
  } as CreateCommentParams
];
const saveResult: SaveComment200Response[] = await saveCommentsBulk(
  tenantId,
  createParams,
  true,   // isLive
  true,   // doSpamCheck
  false,  // sendEmails
  true    // populateNotifications
);

setCommentText

Parameters

Name	Type	Required
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	Yes
commentTextUpdateRequest	CommentTextUpdateRequest	Yes
editKey	string	No
sso	string	No

Response

Returns: SetCommentText200Response

Example

setCommentText Example

Copy

const tenantId: string = 'tenant-42';
const commentId: string = 'cmt-8932';
const broadcastId: string = 'brd-2023-07';
const updateRequest: CommentTextUpdateRequest = {
  text: 'Updated comment text for the product launch — congrats team!',
  mentions: [{ userId: 'user-17', displayName: 'Ava Nguyen' }] as CommentUserMentionInfo[],
  hashtags: [{ tag: 'ProductLaunch' }] as CommentUserHashTagInfo[]
};
const editKey: string = 'edtk-9f7b';
const sso: string = 'sso-token-abc123';
const result: SetCommentText200Response = await setCommentText(tenantId, commentId, broadcastId, updateRequest, editKey, sso);

unBlockUserFromComment

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	Yes
unBlockFromCommentParams	UnBlockFromCommentParams	Yes
userId	string	No
anonUserId	string	No

Response

Returns: UnBlockCommentPublic200Response

Example

unBlockUserFromComment Example

Copy

const tenantId: string = 'tenant_acme_corp';
const id: string = 'comment_9f3b2a';
const unBlockFromCommentParams: UnBlockFromCommentParams = { reason: 'Appeal accepted after review', notifyUser: true };
const userId: string = 'user_84b7';
const result: UnBlockCommentPublic200Response = await unBlockUserFromComment(tenantId, id, unBlockFromCommentParams, userId);

unFlagComment

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	Yes
userId	string	No
anonUserId	string	No

Response

Returns: FlagComment200Response

Example

unFlagComment Example

Copy

const tenantId: string = 'tenant_8247';
const id: string = 'cmt_48291';
const userId: string = 'user_jdoe42';
const anonUserId: string = 'anon_5f9a';
const resultWithUser: FlagComment200Response = await unFlagComment(tenantId, id, userId);
const resultWithAnon: FlagComment200Response = await unFlagComment(tenantId, id, undefined, anonUserId);

unLockComment

Parameters

Name	Type	Required
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	Yes
sso	string	No

Response

Returns: LockComment200Response

Example

unLockComment Example

Copy

const tenantId: string = "tenant_7b3f2d";
const commentId: string = "cmt-92f4b1";
const broadcastId: string = "brd-20260520-01";
const ssoToken: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI1NjciLCJpYXQiOjE2ODYyMzQ1MDB9.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
const resultWithoutSSO: LockComment200Response = await unLockComment(tenantId, commentId, broadcastId);
const resultWithSSO: LockComment200Response = await unLockComment(tenantId, commentId, broadcastId, ssoToken);

unPinComment

Parameters

Name	Type	Required
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	Yes
sso	string	No

Response

Returns: PinComment200Response

Example

unPinComment Example

Copy

const tenantId: string = 'tenant_acme_corp';
const commentId: string = 'comment_8f3b2a';
const broadcastId: string = 'live_20260520_1800';
const sso: string | undefined = 'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.signed.part';
const result: PinComment200Response = await unPinComment(tenantId, commentId, broadcastId, sso);

updateComment

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	Yes
updatableCommentParams	UpdatableCommentParams	Yes
contextUserId	string	No
doSpamCheck	boolean	No
isLive	boolean	No

Response

Returns: FlagCommentPublic200Response

Example

updateComment Example

Copy

const tenantId: string = "tenant_3f47b2a1";
const id: string = "comment_9a12b3c4";
const updatableCommentParams: UpdatableCommentParams = {
  body: "Thanks for the update — I've adjusted my view accordingly."
};
const contextUserId: string = "user_8721";
const doSpamCheck: boolean = true;
const isLive: boolean = false;
const result: FlagCommentPublic200Response = await updateComment(tenantId, id, updatableCommentParams, contextUserId, doSpamCheck, isLive);

voteComment

Parameters

Name	Type	Required
tenantId	string	Yes
commentId	string	Yes
urlId	string	Yes
broadcastId	string	Yes
voteBodyParams	VoteBodyParams	Yes
sessionId	string	No
sso	string	No

Response

Returns: VoteComment200Response

Example

voteComment Example

Copy

const tenantId: string = 'tenant_acme';
const commentId: string = 'cmt_123456789';
const urlId: string = 'https://www.acme-news.com/articles/ai-update-2026';
const broadcastId: string = 'broadcast_live_20260520';
const voteBodyParams: VoteBodyParams = { value: 1, reason: 'Insightful contribution' };
const sessionId: string = 'sess_9b8f7a6c';
const sso: string = 'sso_token_eyJhbGciOiJIUzI1Ni';
const result: VoteComment200Response = await voteComment(tenantId, commentId, urlId, broadcastId, voteBodyParams, sessionId, sso);

getCommentsForUser

Parameters

Name	Type	Required
userId	string	No
tenantId	string	No
urlId	string	No
page	number	No
direction	SortDirections	No
lastGenDate	number	No
repliesToUserId	string	No
fetchPageForCommentId	string	No
includei10n	boolean	No
useFullTranslationIds	boolean	No
locale	string	No
includeConfig	boolean	No
includeNotificationCount	boolean	No
countAll	boolean	No
sso	string	No

Response

Returns: GetCommentsForUserResponse

Example

getCommentsForUser Example

Copy

const userId: string = 'user_82f9b';
const tenantId: string = 'tenant_22';
const page: number = 2;
const lastGenDate: number = Date.now();
const includei10n: boolean = true;
const useFullTranslationIds: boolean = false;
const locale: string = 'en-US';
const includeConfig: boolean = true;
const includeNotificationCount: boolean = true;
const countAll: boolean = false;
const sso: string = 'sso-token-1a2b';
const commentsResponse: GetCommentsForUserResponse = await getCommentsForUser(userId, tenantId, undefined, page, undefined, lastGenDate, undefined, undefined, includei10n, useFullTranslationIds, locale, includeConfig, includeNotificationCount, countAll, sso);

addDomainConfig

Parameters

Name	Type	Required	Description
tenantId	string	Yes
addDomainConfigParams	AddDomainConfigParams	Yes

Response

Returns: AddDomainConfig200Response

Example

addDomainConfig Example

Copy

const tenantId: string = "tenant_7f3b2a1c9";
const addDomainConfigParams: AddDomainConfigParams = {
  domain: "payments.mybusiness.com",
  primary: true,
  validateDns: true
};
const result: AddDomainConfig200Response = await addDomainConfig(tenantId, addDomainConfigParams);

deleteDomainConfig

Parameters

Name	Type	Required	Description
tenantId	string	Yes
domain	string	Yes

Response

Returns: DeleteDomainConfig200Response

Example

deleteDomainConfig Example

Copy

const tenantId: string = 'f47ac10b-58cc-4372-a567-0e02b2c3d479';
const domain: string = 'auth.acmecorp.io';
const options: { notifyAdmin?: boolean } = { notifyAdmin: true };
const result: DeleteDomainConfig200Response = await deleteDomainConfig(tenantId, domain);

getDomainConfig

Parameters

Name	Type	Required	Description
tenantId	string	Yes
domain	string	Yes

Response

Returns: GetDomainConfig200Response

Example

getDomainConfig Example

Copy

const tenantId: string = 'tenant-8a3b2f';
const subdomain: string | undefined = 'payments'; // optional segment
const domain: string = subdomain ? `${subdomain}.acme-corp.com` : 'acme-corp.com';
const domainConfig: GetDomainConfig200Response = await getDomainConfig(tenantId, domain);

getDomainConfigs

Parameters

Name	Type	Required	Description
tenantId	string	Yes

Response

Returns: GetDomainConfigs200Response

Example

getDomainConfigs Example

Copy

(async function run(): Promise<void> {
  const tenantId: string = 'd4f8c9e0-3b1a-4f2a-8c9d-1e2f3a4b5c6d';
  const options: { includeInactive?: boolean } = { includeInactive: true };
  const result: GetDomainConfigs200Response = await getDomainConfigs(tenantId, options);
  console.log(result);
})();

patchDomainConfig

Parameters

Name	Type	Required
tenantId	string	Yes
domainToUpdate	string	Yes
patchDomainConfigParams	PatchDomainConfigParams	Yes

Response

Returns: GetDomainConfig200Response

Example

patchDomainConfig Example

Copy

const tenantId: string = "acme-tenant-001";
const domainToUpdate: string = "billing.acme-corp.com";
const patchDomainConfigParams: PatchDomainConfigParams = {
  ssl: { enabled: true, certificateId: "cert-prod-12345" }, // optional fields included
  redirect: { from: "http://billing.acme-corp.com", to: "https://billing.acme-corp.com", permanent: true }
};
const updatedConfig: GetDomainConfig200Response = await patchDomainConfig(tenantId, domainToUpdate, patchDomainConfigParams);

putDomainConfig

Parameters

Name	Type	Required
tenantId	string	Yes
domainToUpdate	string	Yes
updateDomainConfigParams	UpdateDomainConfigParams	Yes

Response

Returns: GetDomainConfig200Response

Example

putDomainConfig Example

Copy

const tenantId: string = 'tenant_88a2b7';
const domainToUpdate: string = 'login.enterprise-acme.com';
const updateDomainConfigParams: UpdateDomainConfigParams = {
  enabled: true,
  ttlSeconds: 3600,
  redirectToHttps: true,
  aliases: ['login.acme-staging.com'], // optional parameter demonstrated
  metadata: { owner: 'platform-team', environment: 'production' }
};
const updatedConfig: GetDomainConfig200Response = await putDomainConfig(tenantId, domainToUpdate, updateDomainConfigParams);

createEmailTemplate

Parameters

Name	Type	Required	Description
tenantId	string	Yes
createEmailTemplateBody	CreateEmailTemplateBody	Yes

Response

Returns: CreateEmailTemplate200Response

Example

createEmailTemplate Example

Copy

const tenantId: string = "acme-corp-42";
const createEmailTemplateBody: CreateEmailTemplateBody = {
  templateId: "welcome_v1",
  name: "New User Welcome",
  subject: "Welcome to Acme Corp — next steps",
  htmlBody: "<p>Hi \{{firstName}}, welcome to Acme Corp! Use code <strong>GETSTARTED</strong>.</p>",
  description: "Onboarding welcome email for newly registered users", // optional parameter demonstrated
  isActive: true,
  previewText: "Start using your Acme account today" // another optional field
};
const result: CreateEmailTemplate200Response = await createEmailTemplate(tenantId, createEmailTemplateBody);

deleteEmailTemplate

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

Response

Returns: FlagCommentPublic200Response

Example

deleteEmailTemplate Example

Copy

const maybeSuffix: string | undefined = "-prod";
const tenantId: string = `acme-corp${maybeSuffix ?? ""}`;
const templateId: string = "6f1e2d3c-4b5a-6789-0abc-def123456789";
const result: FlagCommentPublic200Response = await deleteEmailTemplate(tenantId, templateId);

deleteEmailTemplateRenderError

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	Yes
errorId	string	Yes

Response

Returns: FlagCommentPublic200Response

Example

deleteEmailTemplateRenderError Example

Copy

const tenantId: string = 'tenant_acme_corp_01';
const id: string = 'welcome_email_template_2025';
const errorId: string = 'render_error_9001';
let note: string | undefined = 'stale renderer failure'; // optional metadata example
const result: FlagCommentPublic200Response = await deleteEmailTemplateRenderError(tenantId, id, errorId);

getEmailTemplate

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

Response

Returns: GetEmailTemplate200Response

Example

getEmailTemplate Example

Copy

const tenantId: string = 'tenant-4a1c2b9f';
const id: string = 'tmpl-7c3b21';
const preferredLocale: string | undefined = 'en-US';
const template: GetEmailTemplate200Response = await getEmailTemplate(tenantId, id);

getEmailTemplateDefinitions

Parameters

Name	Type	Required	Description
tenantId	string	Yes

Response

Returns: GetEmailTemplateDefinitions200Response

Example

getEmailTemplateDefinitions Example

Copy

const tenantId: string = "acme-corp-78";
const response: GetEmailTemplateDefinitions200Response = await getEmailTemplateDefinitions(tenantId, undefined);

getEmailTemplateRenderErrors

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	Yes
skip	number	No

Response

Returns: GetEmailTemplateRenderErrors200Response

Example

getEmailTemplateRenderErrors Example

Copy

const tenantId: string = "tenant_9b3f2c";
const templateId: string = "email_tpl_42";
const skipCount: number = 20;
const resultNoSkip: GetEmailTemplateRenderErrors200Response = await getEmailTemplateRenderErrors(tenantId, templateId);
const resultWithSkip: GetEmailTemplateRenderErrors200Response = await getEmailTemplateRenderErrors(tenantId, templateId, skipCount);

getEmailTemplates

Parameters

Name	Type	Required	Description
tenantId	string	Yes
skip	number	No

Response

Returns: GetEmailTemplates200Response

Example

getEmailTemplates Example

Copy

const tenantId: string = 'acme-tenant-782';
const templates: GetEmailTemplates200Response = await getEmailTemplates(tenantId);
const templatesPaged: GetEmailTemplates200Response = await getEmailTemplates(tenantId, 20);

renderEmailTemplate

Parameters

Name	Type	Required
tenantId	string	Yes
renderEmailTemplateBody	RenderEmailTemplateBody	Yes
locale	string	No

Response

Returns: RenderEmailTemplate200Response

Example

renderEmailTemplate Example

Copy

const tenantId: string = 'acme-corp-987';
const renderEmailTemplateBody: RenderEmailTemplateBody = {
  templateId: 'user-invite',
  subject: "You're invited to Acme",
  placeholders: { firstName: 'Alex' },
  metadata: { source: 'signup-flow' }
};
const locale: string = 'en-US';
const result: RenderEmailTemplate200Response = await renderEmailTemplate(tenantId, renderEmailTemplateBody, locale);

updateEmailTemplate

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	Yes
updateEmailTemplateBody	UpdateEmailTemplateBody	Yes

Response

Returns: FlagCommentPublic200Response

Example

updateEmailTemplate Example

Copy

const tenantId: string = 'tenant_acme_42';
const id: string = 'emailTemplate_pwd_reset_9f3c';
const updateEmailTemplateBody: UpdateEmailTemplateBody = {
  name: 'Password Reset Notification',
  subject: 'Reset your ACME password',
  html: '<p>Click <a href="\{{reset_link}}">here</a> to reset your password.</p>'
} as UpdateEmailTemplateBody;
const result: FlagCommentPublic200Response = await updateEmailTemplate(tenantId, id, updateEmailTemplateBody);

getEventLog

req tenantId urlId userIdWS

Parameters

Name	Type	Required
tenantId	string	Yes
urlId	string	Yes
userIdWS	string	Yes
startTime	number	Yes
endTime	number	Yes

Response

Returns: GetEventLog200Response

Example

getEventLog Example

Copy

const tenantId: string = "acme-corp";
const urlId: string = "url_4b7f";
const userIdWS: string = "john.doe@acme.com";
const startTime: number = Date.now() - 24 * 60 * 60 * 1000;
const endTime: number = Date.now();
interface OptionalParams { includeMetadata?: boolean; maxItems?: number; }
const opts: OptionalParams = { includeMetadata: true };
const result: GetEventLog200Response = await getEventLog(tenantId, urlId, userIdWS, startTime, endTime);

getGlobalEventLog

req tenantId urlId userIdWS

Parameters

Name	Type	Required
tenantId	string	Yes
urlId	string	Yes
userIdWS	string	Yes
startTime	number	Yes
endTime	number	Yes

Response

Returns: GetEventLog200Response

Example

getGlobalEventLog Example

Copy

const tenantId: string = "tenant-42";
const urlId: string = "url-7f3b";
const userIdWS: string = "user_jdoe";
const startTime: number = Date.now() - 60 * 60 * 1000; // 1 hour ago
const endTime: number = Date.now();
const includeMetadata: boolean | undefined = undefined; // optional flag example
const result: GetEventLog200Response = await getGlobalEventLog(tenantId, urlId, userIdWS, startTime, endTime);

createFeedPost

Parameters

Name	Type	Required
tenantId	string	Yes
createFeedPostParams	CreateFeedPostParams	Yes
broadcastId	string	No
isLive	boolean	No
doSpamCheck	boolean	No
skipDupCheck	boolean	No

Response

Returns: CreateFeedPost200Response

Example

createFeedPost Example

Copy

const tenantId: string = 'tenant-7421';
const imageAsset: FeedPostMediaItemAsset = { url: 'https://cdn.example.com/images/launch.jpg', mimeType: 'image/jpeg', width: 1200, height: 630 };
const mediaItem: FeedPostMediaItem = { type: 'image', assets: [imageAsset], caption: 'Highlights from today’s release' };
const link: FeedPostLink = { url: 'https://www.example.com/releases/v2', title: 'Release notes' };
const createFeedPostParams: CreateFeedPostParams = { title: 'Version 2.0 Released', body: 'We shipped major performance improvements and new features.', media: [mediaItem], link };
const broadcastId: string = 'broadcast-602';
const isLive: boolean = false;
const doSpamCheck: boolean = true;
const result: CreateFeedPost200Response = await createFeedPost(tenantId, createFeedPostParams, broadcastId, isLive, doSpamCheck);

createFeedPostPublic

Parameters

Name	Type	Required
tenantId	string	Yes
createFeedPostParams	CreateFeedPostParams	Yes
broadcastId	string	No
sso	string	No

Response

Returns: CreateFeedPostPublic200Response

Example

createFeedPostPublic Example

Copy

const tenantId: string = 'tenant_98765';
const createFeedPostParams: CreateFeedPostParams = {
  title: 'Weekly Product Update',
  body: 'Released performance improvements and bug fixes across the mobile app.',
  media: [
    {
      url: 'https://cdn.example.com/images/update-2026-05-20.jpg',
      type: 'image',
      assets: [{ url: 'https://cdn.example.com/images/update-2026-05-20.jpg', mimeType: 'image/jpeg' }]
    } as FeedPostMediaItem
  ],
  links: [{ url: 'https://example.com/release-notes/2026-05-20', title: 'Full release notes' } as FeedPostLink],
  tags: ['release', 'mobile', 'performance']
};
const broadcastId: string = 'broadcast_20260520';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
const result: CreateFeedPostPublic200Response = await createFeedPostPublic(tenantId, createFeedPostParams, broadcastId, sso);

deleteFeedPostPublic

Parameters

Name	Type	Required
tenantId	string	Yes
postId	string	Yes
broadcastId	string	No
sso	string	No

Response

Returns: DeleteFeedPostPublic200Response

Example

deleteFeedPostPublic Example

Copy

const tenantId: string = "greenwood-enterprises";
const postId: string = "post_84f3a2b7-9d6c-4e3a-8b2f";
const broadcastId: string = "broadcast-20260520-01";
const sso: string = "sso-token-7f9b3c";
const result: DeleteFeedPostPublic200Response = await deleteFeedPostPublic(tenantId, postId, broadcastId, sso);

getFeedPosts

req tenantId afterId

Parameters

Name	Type	Required
tenantId	string	Yes
afterId	string	No
limit	number	No
tags	Array	No

Response

Returns: GetFeedPosts200Response

Example

getFeedPosts Example

Copy

const tenantId: string = 'tenant_8b7f2c';
const limit: number = 20;
const tags: Array<string> = ['product-updates', 'community'];
const firstPage: GetFeedPosts200Response = await getFeedPosts(tenantId, undefined, limit, tags);
const afterId: string = 'post_9c3d2e';
const secondPage: GetFeedPosts200Response = await getFeedPosts(tenantId, afterId, limit);

getFeedPostsPublic

req tenantId afterId

Parameters

Name	Type	Required
tenantId	string	Yes
afterId	string	No
limit	number	No
tags	Array	No
sso	string	No
isCrawler	boolean	No
includeUserInfo	boolean	No

Response

Returns: GetFeedPostsPublic200Response

Example

getFeedPostsPublic Example

Copy

const response: GetFeedPostsPublic200Response = await getFeedPostsPublic({
  tenantId: 'tenant_acme_corp',
  afterId: 'f8e7c6d5',
  limit: 25,
  tags: ['product', 'release'],
  sso: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTYifQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c',
  isCrawler: false,
  includeUserInfo: true
});

getFeedPostsStats

Parameters

Name	Type	Required
tenantId	string	Yes
postIds	Array	Yes
sso	string	No

Response

Returns: GetFeedPostsStats200Response

Example

getFeedPostsStats Example

Copy

async function fetchStats(): Promise<void> {
  const tenantId: string = 'tenant-4c2b1a';
  const postIds: string[] = ['post_7f1e3a', 'post_9b2c6d'];
  const sso: string | undefined = 'sso_tok_9XyZ123';
  const result: GetFeedPostsStats200Response = await getFeedPostsStats(tenantId, postIds, sso);
  console.log(result);
}
fetchStats();

getUserReactsPublic

Parameters

Name	Type	Required
tenantId	string	Yes
postIds	Array	No
sso	string	No

Response

Returns: GetUserReactsPublic200Response

Example

getUserReactsPublic Example

Copy

const tenantId: string = 'acme-corp-01';
const postIds: string[] = ['6f1e2d3c-4b5a-6789-0abc-def123456789', '9a8b7c6d-5e4f-3210-0fed-cba987654321'];
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sso_payload.signature';
const responseMinimal: GetUserReactsPublic200Response = await getUserReactsPublic(tenantId);
const responseWithOptions: GetUserReactsPublic200Response = await getUserReactsPublic(tenantId, postIds, sso);

reactFeedPostPublic

Parameters

Name	Type	Required
tenantId	string	Yes
postId	string	Yes
reactBodyParams	ReactBodyParams	Yes
isUndo	boolean	No
broadcastId	string	No
urlId	string	No
sso	string	No

Response

Returns: ReactFeedPostPublic200Response

Example

reactFeedPostPublic Example

Copy

const tenantId: string = "global-markets";
const postId: string = "8e2c3f9a-4b6d-4f1a-9c2d-e8a1b2c3d4e5";
const reactBodyParams: ReactBodyParams = { reactionType: "like", clientApp: "web-ui", timestamp: new Date().toISOString() };
const isUndo: boolean = false;
const broadcastId: string = "broadcast-2026-05-20";
const urlId: string = "feed-post-8e2c";
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.fake.payload";
const result: ReactFeedPostPublic200Response = await reactFeedPostPublic(tenantId, postId, reactBodyParams, isUndo, broadcastId, urlId, sso);

updateFeedPost

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	Yes
feedPost	FeedPost	Yes

Response

Returns: FlagCommentPublic200Response

Example

updateFeedPost Example

Copy

const tenantId: string = 'acme-tenant-01';
const id: string = 'feedpost-2026-0001';
const mediaAsset: FeedPostMediaItemAsset = { assetId: 'asset-9876', url: 'https://cdn.acme.com/assets/asset-9876.jpg' } as FeedPostMediaItemAsset;
const mediaItem: FeedPostMediaItem = { id: 'media-1', type: 'image', asset: mediaAsset } as FeedPostMediaItem;
const feedPost: FeedPost = { title: 'Product Launch', body: 'We launched the new product today.', media: [mediaItem], isPinned: true } as FeedPost;
const result: FlagCommentPublic200Response = await updateFeedPost(tenantId, id, feedPost);

updateFeedPostPublic

Parameters

Name	Type	Required
tenantId	string	Yes
postId	string	Yes
updateFeedPostParams	UpdateFeedPostParams	Yes
broadcastId	string	No
sso	string	No

Response

Returns: CreateFeedPostPublic200Response

Example

updateFeedPostPublic Example

Copy

const tenantId: string = 'acme-corp';
const postId: string = 'post_9f2b4a';
const updateFeedPostParams: UpdateFeedPostParams = {
  title: 'Q2 Release Notes',
  body: 'We rolled out feature X, fixed critical bugs, and improved load times.',
  mediaItems: [
    {
      id: 'media_123',
      type: 'image',
      assets: [{ url: 'https://cdn.acme.com/images/release.png', mimeType: 'image/png' }]
    }
  ],
  links: [{ url: 'https://acme.com/releases/q2', title: 'Full release notes' }],
  isPublished: true
};
const broadcastId: string = 'broadcast_20260520';
const sso: string = 'sso_token_ab12cd34';
const result: CreateFeedPostPublic200Response = await updateFeedPostPublic(tenantId, postId, updateFeedPostParams, broadcastId, sso);

flagCommentPublic

Parameters

Name	Type	Required
tenantId	string	Yes
commentId	string	Yes
isFlagged	boolean	Yes
sso	string	No

Response

Returns: FlagCommentPublic200Response

Example

flagCommentPublic Example

Copy

const tenantId: string = "acme-corp-42";
const commentId: string = "comment_7b3a2f";
const isFlagged: boolean = true;
const sso: string | undefined = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyLTI0NSIsImlhdCI6MTY5MzAwMDAwMH0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
const result: FlagCommentPublic200Response = await flagCommentPublic(tenantId, commentId, isFlagged, sso);

getGifLarge

Parameters

Name	Type	Required	Description
tenantId	string	Yes
largeInternalURLSanitized	string	Yes

Response

Returns: GifGetLargeResponse

Example

getGifLarge Example

Copy

const tenantId: string = 'tenant_8a92f4';
const largeInternalURLSanitized: string = 'https://cdn.streamingco.com/gifs/product-demo-large.gif';
let maybeStatus: APIStatus | undefined = undefined; // optional metadata when available
const response: GifGetLargeResponse = await getGifLarge(tenantId, largeInternalURLSanitized);

getGifsSearch

Parameters

Name	Type	Required
tenantId	string	Yes
search	string	Yes
locale	string	No
rating	string	No
page	number	No

Response

Returns: GifSearchResponse

Example

getGifsSearch Example

Copy

(async () => {
  const tenantId: string = "global-media";
  const search: string = "laughing baby";
  const locale: string = "en-US";
  const rating: string = "pg";
  const page: number = 2;
  const result: GifSearchResponse = await getGifsSearch(tenantId, search, locale, rating, page);
  console.log(result);
})();

getGifsTrending

Parameters

Name	Type	Required
tenantId	string	Yes
locale	string	No
rating	string	No
page	number	No

Response

Returns: GifSearchResponse

Example

getGifsTrending Example

Copy

const tenantId: string = 'tenant_42';
const locale: string = 'en-US';
const rating: string = 'PG';
const page: number = 1;
const result: GifSearchResponse = await getGifsTrending(tenantId, locale, rating, page);

addHashTag

Parameters

Name	Type	Required	Description
tenantId	string	No
createHashTagBody	CreateHashTagBody	No

Response

Returns: AddHashTag200Response

Example

addHashTag Example

Copy

const tenantId: string = 'tenant_9f3b21';
const createHashTagBody: CreateHashTagBody = { name: '#product-launch', description: 'Tags for the Q3 product launch campaign', isPublic: true };
const response: AddHashTag200Response = await addHashTag(tenantId, createHashTagBody);
const createHashTagBodyOnly: CreateHashTagBody = { name: '#user-feedback', description: 'Aggregated user feedback', isPublic: false };
const responseWithoutTenant: AddHashTag200Response = await addHashTag(undefined, createHashTagBodyOnly);

addHashTagsBulk

Parameters

Name	Type	Required	Description
tenantId	string	No
bulkCreateHashTagsBody	BulkCreateHashTagsBody	No

Response

Returns: AddHashTagsBulk200Response

Example

addHashTagsBulk Example

Copy

const tenantId: string = 'tenant_8f3b2c';
const customConfig: CustomConfigParameters = { importance: 'low', notifyOnChange: false };
const tag: BulkCreateHashTagsBodyTagsInner = {
  name: 'feature-ui',
  description: 'Marks UI-related feature work',
  color: '#1E90FF',
  customConfig
};
const bulkCreateHashTagsBody: BulkCreateHashTagsBody = { tags: [tag] };
const resultWithTenant: AddHashTagsBulk200Response = await addHashTagsBulk(tenantId, bulkCreateHashTagsBody);
const resultWithoutTenant: AddHashTagsBulk200Response = await addHashTagsBulk(undefined, bulkCreateHashTagsBody);

deleteHashTag

Parameters

Name	Type	Required
tag	string	Yes
tenantId	string	No
deleteHashTagRequest	DeleteHashTagRequest	No

Response

Returns: FlagCommentPublic200Response

Example

deleteHashTag Example

Copy

const tag: string = "outdated-policy";
const tenantId: string = "acme_corp_42";
const deleteHashTagRequest: DeleteHashTagRequest = {};
const result: FlagCommentPublic200Response = await deleteHashTag(tag, tenantId, deleteHashTagRequest);

getHashTags

Parameters

Name	Type	Required	Description
tenantId	string	Yes
page	number	No

Response

Returns: GetHashTags200Response

Example

getHashTags Example

Copy

(async () => {
  const tenantId: string = 'tenant_78b2a9f4';
  const firstPageResult: GetHashTags200Response = await getHashTags(tenantId);
  const secondPageResult: GetHashTags200Response = await getHashTags(tenantId, 2);
  console.log(firstPageResult, secondPageResult);
})();

patchHashTag

Parameters

Name	Type	Required
tag	string	Yes
tenantId	string	No
updateHashTagBody	UpdateHashTagBody	No

Response

Returns: PatchHashTag200Response

Example

patchHashTag Example

Copy

const tag: string = "release-2026";
const tenantId: string = "tenant_7b3f";
const updateHashTagBody: UpdateHashTagBody = {
  label: "Release 2026",
  description: "Tag used to group issues and features for the 2026 product launch",
  isActive: true
};
const result: PatchHashTag200Response = await patchHashTag(tag, tenantId, updateHashTagBody);

createModerator

Parameters

Name	Type	Required	Description
tenantId	string	Yes
createModeratorBody	CreateModeratorBody	Yes

Response

Returns: CreateModerator200Response

Example

createModerator Example

Copy

const tenantId: string = 'tenant_acmecorp_001';
const createModeratorBody: CreateModeratorBody = {
  userId: 'mod-982',
  displayName: 'Ava Johnson',
  email: 'ava.johnson@acme.com',
  roles: ['global_moderator'],
  customConfig: { enableNotifications: true, maxDailyActions: 500 } as CustomConfigParameters
};
const result: CreateModerator200Response = await createModerator(tenantId, createModeratorBody);

deleteModerator

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	Yes
sendEmail	string	No

Response

Returns: FlagCommentPublic200Response

Example

deleteModerator Example

Copy

const tenantId: string = 'acme-corp-42';
const moderatorId: string = 'mod_9374';
const sendEmail: string | undefined = 'notifications@acme-corp.com';
const result: FlagCommentPublic200Response = await deleteModerator(tenantId, moderatorId, sendEmail);

getModerator

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

Response

Returns: GetModerator200Response

Example

getModerator Example

Copy

(async function run(): Promise<void> {
  const tenantId: string = 'tenant_company_82';
  const id: string = 'moderator_4932';
  const response: GetModerator200Response = await getModerator(tenantId, id);
  const moderatorName: string | undefined = response.moderator?.name;
  console.log(moderatorName);
})();

getModerators

Parameters

Name	Type	Required	Description
tenantId	string	Yes
skip	number	No

Response

Returns: GetModerators200Response

Example

getModerators Example

Copy

(async () => {
  const tenantId: string = "tenant_acme_42";
  const moderatorsDefault: GetModerators200Response = await getModerators(tenantId);
  const moderatorsWithSkip: GetModerators200Response = await getModerators(tenantId, 25);
  console.log(moderatorsDefault, moderatorsWithSkip);
})();

sendInvite

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	Yes
fromName	string	Yes

Response

Returns: FlagCommentPublic200Response

Example

sendInvite Example

Copy

const tenantId: string = 'acme-corp-128';
const id: string = 'comment-8421f';
const fromName: string = 'Marcus Lindström';
const note: string | undefined = undefined; // optional parameter example
const response: FlagCommentPublic200Response = await sendInvite(tenantId, id, fromName);

updateModerator

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	Yes
updateModeratorBody	UpdateModeratorBody	Yes

Response

Returns: FlagCommentPublic200Response

Example

updateModerator Example

Copy

const tenantId: string = "acme_corp_tenant_42";
const id: string = "moderator_9f3b";
const updateModeratorBody: UpdateModeratorBody = { role: "lead_moderator" } as UpdateModeratorBody;
const result: FlagCommentPublic200Response = await updateModerator(tenantId, id, updateModeratorBody);

deleteNotificationCount

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

Response

Returns: FlagCommentPublic200Response

Example

deleteNotificationCount Example

Copy

(async function() {
  const tenantId: string = 'tenant_0a1b2c3d';
  const id: string = 'notification-9f8e7d6c';
  const result: FlagCommentPublic200Response = await deleteNotificationCount(tenantId, id);
  console.log(result);
})();

getCachedNotificationCount

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

Response

Returns: GetCachedNotificationCount200Response

Example

getCachedNotificationCount Example

Copy

const tenantId: string = "acme-corp";
const userId: string = "user-1024";
const tenantOverride: string | undefined = undefined; // optional override
const effectiveTenantId: string = tenantOverride ?? tenantId;
const notificationCount: GetCachedNotificationCount200Response = await getCachedNotificationCount(effectiveTenantId, userId);

getNotificationCount

Parameters

Name	Type	Required
tenantId	string	Yes
userId	string	No
urlId	string	No
fromCommentId	string	No
viewed	boolean	No
type	string	No

Response

Returns: GetNotificationCount200Response

Example

getNotificationCount Example

Copy

const tenantId: string = 'tenant_42';
const userId: string | undefined = 'user_7';
const urlId: string | undefined = undefined;
const fromCommentId: string | undefined = undefined;
const viewed: boolean | undefined = true;
const type: string | undefined = 'mention';
const notificationCount: GetNotificationCount200Response = await getNotificationCount(tenantId, userId, urlId, fromCommentId, viewed, type);

getNotifications

Parameters

Name	Type	Required
tenantId	string	Yes
userId	string	No
urlId	string	No
fromCommentId	string	No
viewed	boolean	No
type	string	No
skip	number	No

Response

Returns: GetNotifications200Response

Example

getNotifications Example

Copy

const tenantId: string = "tenant_4f7a9c";
const userId: string | undefined = "user_83a2";
const urlId: string | undefined = "https://app.example.com/posts/123";
const fromCommentId: string | undefined = "cmt_1024";
const viewed: boolean | undefined = false;
const type: string | undefined = "mention";
const skip: number | undefined = 25;
const notifications: GetNotifications200Response = await getNotifications(tenantId, userId, urlId, fromCommentId, viewed, type, skip);

updateNotification

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	Yes
updateNotificationBody	UpdateNotificationBody	Yes
userId	string	No

Response

Returns: FlagCommentPublic200Response

Example

updateNotification Example

Copy

const tenantId: string = 'acme-inc';
const id: string = 'f47ac10b-58cc-4372-a567-0e02b2c3d479';
const updateNotificationBody: UpdateNotificationBody = { resolved: true, reason: 'Offensive language detected', notes: 'Marked by moderator' };
const userId: string = 'user_1024';
const resultWithUser: FlagCommentPublic200Response = await updateNotification(tenantId, id, updateNotificationBody, userId);
const resultWithoutUser: FlagCommentPublic200Response = await updateNotification(tenantId, id, updateNotificationBody);

addPage

Parameters

Name	Type	Required	Description
tenantId	string	Yes
createAPIPageData	CreateAPIPageData	Yes

Response

Returns: AddPageAPIResponse

Example

addPage Example

Copy

const tenantId: string = 'tenant_9b3f2c1a';
const createData: CreateAPIPageData = {
  title: 'Q3 Product Roadmap',
  slug: 'q3-product-roadmap',
  content: '<h1>Goals</h1><p>Focus on performance and reliability improvements.</p>',
  authorId: 'user_84c2',
  published: false,            // optional flag demonstrated
  tags: ['product', 'roadmap'] // optional metadata demonstrated
};
const result: AddPageAPIResponse = await addPage(tenantId, createData);

deletePage

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

Response

Returns: DeletePageAPIResponse

Example

deletePage Example

Copy

async function run(deleteImmediately?: boolean): Promise<void> {
  const tenantId: string = 'acme_corp_tenant_01';
  const id: string = 'page_5f8b3a9e';
  const result: DeletePageAPIResponse = await deletePage(tenantId, id);
  const logAction: boolean = deleteImmediately ?? false;
  if (logAction) console.log('Deleted page', id, result);
}
run();

getPageByURLId

Parameters

Name	Type	Required	Description
tenantId	string	Yes
urlId	string	Yes

Response

Returns: GetPageByURLIdAPIResponse

Example

getPageByURLId Example

Copy

interface APIPage { id: string; title: string; content?: string; published: boolean }
interface GetPageByURLIdAPIResponse { page: APIPage; retrievedAt?: string }
const tenantId: string = 'acme-enterprises';
const urlId: string = '6f1e2d3c-4b5a-6789-abcd-1234567890ef';
const result: GetPageByURLIdAPIResponse = await getPageByURLId(tenantId, urlId);
const pageTitle: string = result.page.title;
const contentPreview: string | undefined = result.page.content?.slice(0, 120);

getPages

Parameters

Name	Type	Required	Description
tenantId	string	Yes

Response

Returns: GetPagesAPIResponse

Example

getPages Example

Copy

const tenantId: string = "tenant_3f8d9b2a";
const options: { page?: number; pageSize?: number } = { page: 1, pageSize: 25 };
const pagesResponse: GetPagesAPIResponse = await getPages(tenantId, options);

patchPage

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	Yes
updateAPIPageData	UpdateAPIPageData	Yes

Response

Returns: PatchPageAPIResponse

Example

patchPage Example

Copy

(async () => {
  const tenantId: string = 'acme-enterprises';
  const id: string = '9f8b7c6d-4a2e-11ec-8d3d-0242ac130003';
  const updateData: UpdateAPIPageData = { title: 'Q2 Financial Summary' }; // other fields optional
  const result: PatchPageAPIResponse = await patchPage(tenantId, id, updateData);
  console.log(result);
})();

deletePendingWebhookEvent

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

Response

Returns: FlagCommentPublic200Response

Example

deletePendingWebhookEvent Example

Copy

async function fetchDeletedEventOptional(tenantId: string, id: string, includeRelated?: boolean): Promise<FlagCommentPublic200Response> {
  const res: FlagCommentPublic200Response = await deletePendingWebhookEvent(tenantId, id);
  if (includeRelated) { /* optionally process related data */ }
  return res;
}
const tenantId: string = 'acme-corp-tenant-42';
const webhookId: string = 'wh_evt_20260520_9f2b7';
const deletedEvent: FlagCommentPublic200Response = await deletePendingWebhookEvent(tenantId, webhookId);

getPendingWebhookEventCount

Parameters

Name	Type	Required
tenantId	string	Yes
commentId	string	No
externalId	string	No
eventType	string	No
type	string	No
domain	string	No
attemptCountGT	number	No

Response

Returns: GetPendingWebhookEventCount200Response

Example

getPendingWebhookEventCount Example

Copy

const tenantId: string = 'tenant_42';
const commentId: string | undefined = 'cmt-98765';
const externalId: string | undefined = 'order-5643';
const eventType: string | undefined = 'comment.created';
const typeParam: string | undefined = 'webhook';
const domain: string | undefined = 'app.mycompany.com';
const attemptCountGT: number | undefined = 2;
const result: GetPendingWebhookEventCount200Response = await getPendingWebhookEventCount(
  tenantId,
  commentId,
  externalId,
  eventType,
  typeParam,
  domain,
  attemptCountGT
);

getPendingWebhookEvents

Parameters

Name	Type	Required
tenantId	string	Yes
commentId	string	No
externalId	string	No
eventType	string	No
type	string	No
domain	string	No
attemptCountGT	number	No
skip	number	No

Response

Returns: GetPendingWebhookEvents200Response

Example

getPendingWebhookEvents Example

Copy

(async () => {
  const tenantId: string = 'd6e8f3a2-4b9f-4c3b-8123-1f2e3d4c5b6a';
  const commentId: string = 'cmt_987654321';
  const eventType: string = 'COMMENT_CREATED';
  const domain: string = 'comments.prod.example.com';
  const attemptCountGT: number = 1;
  const skip: number = 0;
  const result: GetPendingWebhookEvents200Response = await getPendingWebhookEvents(
    tenantId,
    commentId,
    undefined,
    eventType,
    undefined,
    domain,
    attemptCountGT,
    skip
  );
  console.log(result);
})();

createQuestionConfig

Parameters

Name	Type	Required	Description
tenantId	string	Yes
createQuestionConfigBody	CreateQuestionConfigBody	Yes

Response

Returns: CreateQuestionConfig200Response

Example

createQuestionConfig Example

Copy

const tenantId: string = "acme-enterprises";
const createQuestionConfigBody: CreateQuestionConfigBody = {
  title: "Product Satisfaction",
  description: "Quarterly feedback on overall product experience",
  isActive: true,
  customOptions: [
    { label: "Very satisfied", value: "5" },
    { label: "Somewhat satisfied", value: "4" }
  ] // optional fields like description are shown; others omitted
};
const result: CreateQuestionConfig200Response = await createQuestionConfig(tenantId, createQuestionConfigBody);

deleteQuestionConfig

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

Response

Returns: FlagCommentPublic200Response

Example

deleteQuestionConfig Example

Copy

const tenantId: string = 'acme-enterprises';
const id: string = 'question-config_7a1b2c';
const result: FlagCommentPublic200Response = await deleteQuestionConfig(tenantId, id);

getQuestionConfig

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

Response

Returns: GetQuestionConfig200Response

Example

getQuestionConfig Example

Copy

(async () => {
  const tenantId: string = 'acme-enterprises';
  const id: string = 'question-987654321';
  const config: GetQuestionConfig200Response = await getQuestionConfig(tenantId, id);
  console.log(config);
})();

getQuestionConfigs

Parameters

Name	Type	Required	Description
tenantId	string	Yes
skip	number	No

Response

Returns: GetQuestionConfigs200Response

Example

getQuestionConfigs Example

Copy

(async () => {
  const tenantId: string = 'tenant-8f4b2c';
  const skip: number = 40;
  const responseWithoutSkip: GetQuestionConfigs200Response = await getQuestionConfigs(tenantId);
  const responseWithSkip: GetQuestionConfigs200Response = await getQuestionConfigs(tenantId, skip);
  console.log(responseWithoutSkip, responseWithSkip);
})();

updateQuestionConfig

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	Yes
updateQuestionConfigBody	UpdateQuestionConfigBody	Yes

Response

Returns: FlagCommentPublic200Response

Example

updateQuestionConfig Example

Copy

const tenantId: string = 'acme-corp-927';
const id: string = 'questionCfg-4f1d';
const customOption: QuestionConfigCustomOptionsInner = { label: 'Mobile app', value: 'mobile_users' } as QuestionConfigCustomOptionsInner;
const updateQuestionConfigBody: UpdateQuestionConfigBody = {
  title: 'Post-purchase satisfaction',
  enabled: true,
  customOptions: [customOption],
  description: 'Collect quick feedback after checkout'
} as UpdateQuestionConfigBody;
const result: FlagCommentPublic200Response = await updateQuestionConfig(tenantId, id, updateQuestionConfigBody);

createQuestionResult

Parameters

Name	Type	Required	Description
tenantId	string	Yes
createQuestionResultBody	CreateQuestionResultBody	Yes

Response

Returns: CreateQuestionResult200Response

Example

createQuestionResult Example

Copy

const tenantId: string = 'tenant_7f3a2b';
const createQuestionResultBody: CreateQuestionResultBody = {
  questionId: 'q_92a1',
  respondentId: 'user_71c',
  answers: [{ subQuestionId: 'sq1', value: 'Yes' }],
  meta: [{ key: 'source', value: 'web' }] // optional metadata
};
const result: CreateQuestionResult200Response = await createQuestionResult(tenantId, createQuestionResultBody);

deleteQuestionResult

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

Response

Returns: FlagCommentPublic200Response

Example

deleteQuestionResult Example

Copy

const tenantId: string = 'tenant_acme_corp_01';
const id: string = 'questionResult_87b4f2a9';
const result: FlagCommentPublic200Response = await deleteQuestionResult(tenantId, id);

getQuestionResult

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

Response

Returns: GetQuestionResult200Response

Example

getQuestionResult Example

Copy

const tenantId: string = 'acme-corp-42';
const id: string = 'question-9f8b7c';
const includeComments: boolean | undefined = true; // optional parameter example
const result: GetQuestionResult200Response = await getQuestionResult(tenantId, id);
console.log(result);

getQuestionResults

Parameters

Name	Type	Required
tenantId	string	Yes
urlId	string	No
userId	string	No
startDate	string	No
questionId	string	No
questionIds	string	No
skip	number	No

Response

Returns: GetQuestionResults200Response

Example

getQuestionResults Example

Copy

(async () => {
  const tenantId: string = "tenant_9b3f";
  const urlId: string = "survey-2026-spring";
  const userId: string = "user_00123";
  const startDate: string = "2026-04-01T00:00:00Z";
  const questionIds: string = "q_42,q_43";
  const skip: number = 0;
  const result: GetQuestionResults200Response = await getQuestionResults(tenantId, urlId, userId, startDate, undefined, questionIds, skip);
  console.log(result);
})();

updateQuestionResult

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	Yes
updateQuestionResultBody	UpdateQuestionResultBody	Yes

Response

Returns: FlagCommentPublic200Response

Example

updateQuestionResult Example

Copy

const tenantId: string = "acme-marketing";
const id: string = "7f3a2c1e-4b6d-4c9f-8a2e-0d9b6f1c2e3a";
const updateQuestionResultBody: UpdateQuestionResultBody = {
  verdict: "correct",
  note: "Peer-reviewed and confirmed",
  meta: [] as MetaItem[] // optional metadata omitted/empty
} as UpdateQuestionResultBody;
const result: FlagCommentPublic200Response = await updateQuestionResult(tenantId, id, updateQuestionResultBody);

aggregateQuestionResults

Parameters

Name	Type	Required
tenantId	string	Yes
questionId	string	No
questionIds	Array	No
urlId	string	No
timeBucket	AggregateTimeBucket	No
startDate	Date	No
forceRecalculate	boolean	No

Response

Returns: AggregateQuestionResults200Response

Example

aggregateQuestionResults Example

Copy

const tenantId: string = 'tenant_6f8a2b';
const questionIds: string[] = ['Q-1001', 'Q-1002'];
const startDate: Date = new Date('2026-01-01T00:00:00Z');
const forceRecalculate: boolean = true;
const result: AggregateQuestionResults200Response = await aggregateQuestionResults(tenantId, undefined, questionIds, undefined, undefined, startDate, forceRecalculate);

bulkAggregateQuestionResults

Parameters

Name	Type	Required
tenantId	string	Yes
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	Yes
forceRecalculate	boolean	No

Response

Returns: BulkAggregateQuestionResults200Response

Example

bulkAggregateQuestionResults Example

Copy

const tenantId: string = 'tenant_8b3d72';
const request: BulkAggregateQuestionResultsRequest = {
  items: [
    {
      questionId: 'q-00123',
      includeSubQuestions: true,
      timeRange: { start: '2025-01-01T00:00:00Z', end: '2025-01-31T23:59:59Z' }
    }
  ],
  bucket: { interval: 'day' }
} as BulkAggregateQuestionResultsRequest;
const result: BulkAggregateQuestionResults200Response = await bulkAggregateQuestionResults(tenantId, request, true);

combineCommentsWithQuestionResults

Parameters

Name	Type	Required
tenantId	string	Yes
questionId	string	No
questionIds	Array	No
urlId	string	No
startDate	Date	No
forceRecalculate	boolean	No
minValue	number	No
maxValue	number	No
limit	number	No

Response

Returns: CombineCommentsWithQuestionResults200Response

Example

combineCommentsWithQuestionResults Example

Copy

const tenantId: string = 'tenant_12345';
const questionIds: string[] = ['q-101', 'q-102'];
const urlId: string = 'url_789';
const startDate: Date = new Date('2026-01-01T00:00:00Z');
const forceRecalculate: boolean = true;
const minValue: number = 1;
const maxValue: number = 5;
const limit: number = 100;
const combined: CombineCommentsWithQuestionResults200Response = await combineCommentsWithQuestionResults({
  tenantId,
  questionIds,
  urlId,
  startDate,
  forceRecalculate,
  minValue,
  maxValue,
  limit
});

addSSOUser

Parameters

Name	Type	Required	Description
tenantId	string	Yes
createAPISSOUserData	CreateAPISSOUserData	Yes

Response

Returns: AddSSOUserAPIResponse

Example

addSSOUser Example

Copy

const tenantId: string = 'acme-organization-92';
const createAPISSOUserData: CreateAPISSOUserData = {
  email: 'sarah.connor@skynetpartners.com',
  firstName: 'Sarah',
  lastName: 'Connor',
  externalId: 'okta|678901234',
  roles: ['admin', 'developer'], // optional field demonstrated
  displayName: 'Sarah Connor'    // optional field demonstrated
};
const addUserResult: AddSSOUserAPIResponse = await addSSOUser(tenantId, createAPISSOUserData);

deleteSSOUser

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	Yes
deleteComments	boolean	No
commentDeleteMode	string	No

Response

Returns: DeleteSSOUserAPIResponse

Example

deleteSSOUser Example

Copy

const tenantId: string = 'enterprise-acme-123';
const id: string = 'f47ac10b-58cc-4372-a567-0e02b2c3d479';
const deleteComments: boolean = true;
const commentDeleteMode: string = 'hard';
const result: DeleteSSOUserAPIResponse = await deleteSSOUser(tenantId, id, deleteComments, commentDeleteMode);

getSSOUserByEmail

Parameters

Name	Type	Required	Description
tenantId	string	Yes
email	string	Yes

Response

Returns: GetSSOUserByEmailAPIResponse

Example

getSSOUserByEmail Example

Copy

const tenantId: string = 'acme-enterprises-7';
const email: string = 'jane.doe@acme.com';
const response: GetSSOUserByEmailAPIResponse = await getSSOUserByEmail(tenantId, email);
const getUserIfEmailProvided: (tenant: string, mail?: string) => Promise<GetSSOUserByEmailAPIResponse | undefined> =
  async (tenant: string, mail?: string): Promise<GetSSOUserByEmailAPIResponse | undefined> =>
    mail ? await getSSOUserByEmail(tenant, mail) : undefined;

getSSOUserById

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

Response

Returns: GetSSOUserByIdAPIResponse

Example

getSSOUserById Example

Copy

const tenantId: string = 'acme-inc-042';
const id: string = 'user-00098765';
const result: GetSSOUserByIdAPIResponse = await getSSOUserById(tenantId, id);

getSSOUsers

Parameters

Name	Type	Required	Description
tenantId	string	Yes
skip	number	No

Response

Returns: GetSSOUsers200Response

Example

getSSOUsers Example

Copy

const tenantId: string = 'acme-corp-001';
const skip: number = 25;
const response: GetSSOUsers200Response = await getSSOUsers(tenantId);
const responseWithSkip: GetSSOUsers200Response = await getSSOUsers(tenantId, skip);

patchSSOUser

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	Yes
updateAPISSOUserData	UpdateAPISSOUserData	Yes
updateComments	boolean	No

Response

Returns: PatchSSOUserAPIResponse

Example

patchSSOUser Example

Copy

const tenantId: string = "tenant_8f3a4b2c";
const id: string = "sso_user_72b9a1";
const updateAPISSOUserData: UpdateAPISSOUserData = {
  email: "jane.doe@acme-corp.com",
  displayName: "Jane Doe",
  department: "Product",
  roles: ["user", "editor"]
};
const updateComments: boolean = true;
const result: PatchSSOUserAPIResponse = await patchSSOUser(tenantId, id, updateAPISSOUserData, updateComments)

putSSOUser

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	Yes
updateAPISSOUserData	UpdateAPISSOUserData	Yes
updateComments	boolean	No

Response

Returns: PutSSOUserAPIResponse

Example

putSSOUser Example

Copy

const tenantId: string = 'acme-enterprises-42';
const id: string = 'usr-73a1b2';
const updateAPISSOUserData: UpdateAPISSOUserData = {
  email: 'marcus.ingram@acme.com',
  givenName: 'Marcus',
  familyName: 'Ingram',
  roles: ['editor', 'project_owner'],
  enabled: true
};
const result: PutSSOUserAPIResponse = await putSSOUser(tenantId, id, updateAPISSOUserData, true);

createSubscription

Parameters

Name	Type	Required	Description
tenantId	string	Yes
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	Yes

Response

Returns: CreateSubscriptionAPIResponse

Example

createSubscription Example

Copy

const tenantId: string = "acme-enterprises-987";
const createData: CreateAPIUserSubscriptionData = {
  apiUserId: "user_72f4a1",
  planId: "enterprise_annual",
  startDate: "2026-06-01T00:00:00Z",
  autoRenew: true,
  trialPeriodDays: 30
};
const result: CreateSubscriptionAPIResponse = await createSubscription(tenantId, createData);

deleteSubscription

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	Yes
userId	string	No

Response

Returns: DeleteSubscriptionAPIResponse

Example

deleteSubscription Example

Copy

const tenantId: string = "acme-corp-84";
const id: string = "sub_92f1b3a7";
const responseWithoutUser: DeleteSubscriptionAPIResponse = await deleteSubscription(tenantId, id);
const userId: string = "user-2983";
const responseWithUser: DeleteSubscriptionAPIResponse = await deleteSubscription(tenantId, id, userId);

getSubscriptions

Parameters

Name	Type	Required	Description
tenantId	string	Yes
userId	string	No

Response

Returns: GetSubscriptionsAPIResponse

Example

getSubscriptions Example

Copy

const tenantId: string = "contoso-9a1b2c";
const userId: string = "u-482f6";
const subscriptions: GetSubscriptionsAPIResponse = await getSubscriptions(tenantId);
const userSubscriptions: GetSubscriptionsAPIResponse = await getSubscriptions(tenantId, userId);

updateSubscription

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	Yes
updateAPIUserSubscriptionData	UpdateAPIUserSubscriptionData	Yes
userId	string	No

Response

Returns: UpdateSubscriptionAPIResponse

Example

updateSubscription Example

Copy

const tenantId: string = 'a3f9d6b2-7c4e-4b1a-9f2d-0e6c8a1b2d3f';
const id: string = 'sub_6f4b2a9e-3c1d-4e8f-9b2a-7d5c3e1f0a8b';
const userId: string = 'user_58b2d4f1-6a7c-4e9b-8d1f-2c3a5b6e7f9d';
const updateData: UpdateAPIUserSubscriptionData = {
  planId: 'business_annual',
  seats: 25,
  autoRenew: false,
  nextBillingDate: '2026-08-01'
};
const result: UpdateSubscriptionAPIResponse = await updateSubscription(tenantId, id, updateData, userId);

getTenantDailyUsages

Parameters

Name	Type	Required
tenantId	string	Yes
yearNumber	number	No
monthNumber	number	No
dayNumber	number	No
skip	number	No

Response

Returns: GetTenantDailyUsages200Response

Example

getTenantDailyUsages Example

Copy

const tenantId: string = 'acme-corp-7';
const yearNumber: number = 2026;
const monthNumber: number = 4;
const skip: number = 10;
const result: GetTenantDailyUsages200Response = await getTenantDailyUsages(tenantId, yearNumber, monthNumber, undefined, skip);

createTenantPackage

Parameters

Name	Type	Required	Description
tenantId	string	Yes
createTenantPackageBody	CreateTenantPackageBody	Yes

Response

Returns: CreateTenantPackage200Response

Example

createTenantPackage Example

Copy

const tenantId: string = "tenant_acme_corp_001";
const createTenantPackageBody: CreateTenantPackageBody = {
  packageName: "Acme Moderation Pack",
  version: "1.2.0",
  description: "Moderation settings tailored for Acme forums",
  allowGuestPosting: false,
  customConfig: {
    profanityLevel: "medium",
    imageMaxMb: 8
  }
} as CreateTenantPackageBody;
const result: CreateTenantPackage200Response = await createTenantPackage(tenantId, createTenantPackageBody);

deleteTenantPackage

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

Response

Returns: FlagCommentPublic200Response

Example

deleteTenantPackage Example

Copy

const tenantId: string = 'tenant_acme_corp';
const packageId: string = 'pkg-9b2f4c';
const reason: string | undefined = 'Remove obsolete feature set';
const result: FlagCommentPublic200Response = await deleteTenantPackage(tenantId, packageId);

getTenantPackage

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

Response

Returns: GetTenantPackage200Response

Example

getTenantPackage Example

Copy

const tenantId: string = 'org-6412';
const id: string = 'pkg-7f3b1c4a-9a2d-4e3b-b8c2-1a2b3c4d5e6f';
const includePreview: boolean | undefined = undefined; // optional parameter example
const packageResponse: GetTenantPackage200Response = await getTenantPackage(tenantId, id);

getTenantPackages

Parameters

Name	Type	Required	Description
tenantId	string	Yes
skip	number	No

Response

Returns: GetTenantPackages200Response

Example

getTenantPackages Example

Copy

const tenantId: string = 'tenant-7b3c2f';
const skipCount: number = 10;
const packages: GetTenantPackages200Response = await getTenantPackages(tenantId, skipCount);
const packagesFromStart: GetTenantPackages200Response = await getTenantPackages(tenantId);

replaceTenantPackage

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	Yes
replaceTenantPackageBody	ReplaceTenantPackageBody	Yes

Response

Returns: FlagCommentPublic200Response

Example

replaceTenantPackage Example

Copy

(async () => {
  const tenantId: string = 'tenant_8a1f';
  const id: string = 'pkg_bronze_2026';
  const replaceTenantPackageBody: ReplaceTenantPackageBody = {
    name: 'Bronze Plan',
    description: 'Entry tier with basic moderation and analytics',
    apiStatus: { status: 'active' },
    customConfigParameters: { maxCommentsPerUser: 100 }
  } as ReplaceTenantPackageBody;
  const result: FlagCommentPublic200Response = await replaceTenantPackage(tenantId, id, replaceTenantPackageBody);
  console.log(result);
})();

updateTenantPackage

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	Yes
updateTenantPackageBody	UpdateTenantPackageBody	Yes

Response

Returns: FlagCommentPublic200Response

Example

updateTenantPackage Example

Copy

(async () => {
  const tenantId: string = "tenant_sf_001";
  const id: string = "pkg-premium-v2";
  const updateTenantPackageBody: UpdateTenantPackageBody = {
    name: "San Francisco Premium",
    enabled: true,
    customConfig: { maxComments: 500 },
    tosConfig: { required: true } // optional fields demonstrated by presence; others omitted
  } as UpdateTenantPackageBody;
  const result: FlagCommentPublic200Response = await updateTenantPackage(tenantId, id, updateTenantPackageBody);
  console.log(result);
})();

createTenantUser

Parameters

Name	Type	Required	Description
tenantId	string	Yes
createTenantUserBody	CreateTenantUserBody	Yes

Response

Returns: CreateTenantUser200Response

Example

createTenantUser Example

Copy

const tenantId: string = 'tenant-54b2';
const createTenantUserBody: CreateTenantUserBody = {
  email: 'jane.doe@acme.com',
  displayName: 'Jane Doe',
  role: 'editor',
  sendInvite: true
};
const result: CreateTenantUser200Response = await createTenantUser(tenantId, createTenantUserBody);

deleteTenantUser

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	Yes
deleteComments	string	No
commentDeleteMode	string	No

Response

Returns: FlagCommentPublic200Response

Example

deleteTenantUser Example

Copy

(async () => {
  const tenantId: string = 'acme-corp-01';
  const id: string = 'user-84f3b2';
  const deleteComments: string = 'Permanently remove legacy flagged comments from 2020';
  const commentDeleteMode: string = 'hard';
  const result: FlagCommentPublic200Response = await deleteTenantUser(tenantId, id, deleteComments, commentDeleteMode);
  console.log(result);
})();

getTenantUser

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

Response

Returns: GetTenantUser200Response

Example

getTenantUser Example

Copy

(async () => {
  const tenantId: string = 'tenant_acme_01';
  const id: string = 'user_4b7f9c';
  const result: GetTenantUser200Response = await getTenantUser(tenantId, id);
  const primaryEmail: string | undefined = result.user?.email;
  console.log(primaryEmail);
})();

getTenantUsers

Parameters

Name	Type	Required	Description
tenantId	string	Yes
skip	number	No

Response

Returns: GetTenantUsers200Response

Example

getTenantUsers Example

Copy

const tenantId: string = 'acme-corp-tenant-42';
const usersFirstPage: GetTenantUsers200Response = await getTenantUsers(tenantId);
const usersSecondPage: GetTenantUsers200Response = await getTenantUsers(tenantId, 50);

replaceTenantUser

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	Yes
replaceTenantUserBody	ReplaceTenantUserBody	Yes
updateComments	string	No

Response

Returns: FlagCommentPublic200Response

Example

replaceTenantUser Example

Copy

const tenantId: string = "tenant_acmeCorp";
const id: string = "user_84b2";
const replaceTenantUserBody: ReplaceTenantUserBody = {
  email: "alice.jenkins@acmecorp.com",
  displayName: "Alice Jenkins",
  roles: ["moderator", "editor"],
  disabled: false
} as ReplaceTenantUserBody;
const updateComments: string = "Migrated user account and reattributed historical comments";
const result: FlagCommentPublic200Response = await replaceTenantUser(tenantId, id, replaceTenantUserBody, updateComments);

sendLoginLink

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	Yes
redirectURL	string	No

Response

Returns: FlagCommentPublic200Response

Example

sendLoginLink Example

Copy

(async () => {
  const tenantId: string = 'tenant_acme_93';
  const id: string = 'user_72f9b';
  const redirectURL: string = 'https://app.mycompany.com/welcome';
  const result: FlagCommentPublic200Response = await sendLoginLink(tenantId, id, redirectURL);
  console.log(result);
})();

updateTenantUser

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	Yes
updateTenantUserBody	UpdateTenantUserBody	Yes
updateComments	string	No

Response

Returns: FlagCommentPublic200Response

Example

updateTenantUser Example

Copy

const tenantId: string = "tenant_4b72a1";
const id: string = "user_7f8d2c";
const updateTenantUserBody: UpdateTenantUserBody = {
  email: "jane.doe@acmecorp.com",
  displayName: "Jane Doe",
  roles: ["editor"],
  isActive: true
};
const updateComments: string = "Promoted to editor after Q2 review";
const result: FlagCommentPublic200Response = await updateTenantUser(tenantId, id, updateTenantUserBody, updateComments);

createTenant

Parameters

Name	Type	Required	Description
tenantId	string	Yes
createTenantBody	CreateTenantBody	Yes

Response

Returns: CreateTenant200Response

Example

createTenant Example

Copy

const tenantId: string = "acme-enterprises-001";
const domainConfig: APIDomainConfiguration = { primaryDomain: "acme-enterprises.com", redirectToPrimary: true };
const billingInfo: BillingInfo = { planId: "business-monthly", billingContactEmail: "finance@acme-enterprises.com" };
const initialSite: ImportedSiteType = { siteName: "Main Site", siteUrl: "https://acme-enterprises.com" };
const tosConfig: TOSConfig = { required: true, url: "https://acme-enterprises.com/terms" };
const createTenantBody: CreateTenantBody = {
  name: "Acme Enterprises",
  description: "Primary tenant for Acme Enterprises",
  domainConfiguration: domainConfig,
  billingInfo,
  initialSite, // optional parameter demonstrated
  tosConfig
};
const result: CreateTenant200Response = await createTenant(tenantId, createTenantBody);

deleteTenant

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	Yes
sure	string	No

Response

Returns: FlagCommentPublic200Response

Example

deleteTenant Example

Copy

const tenantId: string = 'tenant-84f2';
const id: string = 'delete-9b3f7a';
const resultWithoutSure: FlagCommentPublic200Response = await deleteTenant(tenantId, id);
const resultWithSure: FlagCommentPublic200Response = await deleteTenant(tenantId, id, 'confirm-deletion');

getTenant

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

Response

Returns: GetTenant200Response

Example

getTenant Example

Copy

(async () => {
  const tenantId: string = 'tenant-4f2b';
  const id: string = 'site-91a7';
  const tenantResponse: GetTenant200Response = await getTenant(tenantId, id);
  const billingInfo: BillingInfo | undefined = (tenantResponse as unknown as { billing?: BillingInfo }).billing;
})();

getTenants

Parameters

Name	Type	Required
tenantId	string	Yes
meta	string	No
skip	number	No

Response

Returns: GetTenants200Response

Example

getTenants Example

Copy

const tenantId: string = 'org_9a12f4';
const meta: string = 'include=domains,billing';
const skip: number = 20;
const tenantsResponse: GetTenants200Response = await getTenants(tenantId, meta, skip);

updateTenant

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	Yes
updateTenantBody	UpdateTenantBody	Yes

Response

Returns: FlagCommentPublic200Response

Example

updateTenant Example

Copy

const tenantId: string = 'acme-corp-001';
const id: string = 'tenant-42';
const billingInfo: BillingInfo = { billingEmail: 'billing@acme.com', address: '123 Market St' } as BillingInfo;
const updateTenantBody: UpdateTenantBody = { displayName: 'Acme Corporation', billingInfo } as UpdateTenantBody;
const result: FlagCommentPublic200Response = await updateTenant(tenantId, id, updateTenantBody);

changeTicketState

Parameters

Name	Type	Required
tenantId	string	Yes
userId	string	Yes
id	string	Yes
changeTicketStateBody	ChangeTicketStateBody	Yes

Response

Returns: ChangeTicketState200Response

Example

changeTicketState Example

Copy

const tenantId: string = "acme-corp-001";
const userId: string = "user_8742";
const id: string = "TCK-2026-00042";
const changeTicketStateBody: ChangeTicketStateBody = {
  state: "closed",
  comment: "Fixed in backend service; verified by QA",
  notifyFollowers: false
} as ChangeTicketStateBody;
const result: ChangeTicketState200Response = await changeTicketState(tenantId, userId, id, changeTicketStateBody);

createTicket

Parameters

Name	Type	Required
tenantId	string	Yes
userId	string	Yes
createTicketBody	CreateTicketBody	Yes

Response

Returns: CreateTicket200Response

Example

createTicket Example

Copy

const tenantId: string = 'acme-company-001';
const userId: string = 'u_78f4b2';
const createTicketBody: CreateTicketBody = {
  title: 'Unable to access project dashboard',
  description: 'Receiving 403 when accessing /dashboard for project X',
  priority: 'high',
  tags: ['dashboard', 'access'] // optional field demonstrated
};
const result: CreateTicket200Response = await createTicket(tenantId, userId, createTicketBody);

getTicket

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	Yes
userId	string	No

Response

Returns: GetTicket200Response

Example

getTicket Example

Copy

(async () => {
  const tenantId: string = 'tenant_acme_01';
  const id: string = 'TCK-20260520-001';
  const ticket: GetTicket200Response = await getTicket(tenantId, id);
  const userId: string = 'user_98765';
  const userTicket: GetTicket200Response = await getTicket(tenantId, 'TCK-20260520-002', userId);
  console.log(ticket, userTicket);
})();

getTickets

Parameters

Name	Type	Required
tenantId	string	Yes
userId	string	No
state	number	No
skip	number	No
limit	number	No

Response

Returns: GetTickets200Response

Example

getTickets Example

Copy

const tenantId: string = 'acme-corp-001';
const userId: string | undefined = 'user-42';
const state: number | undefined = 2;
const skip: number | undefined = 0;
const limit: number | undefined = 50;
const tickets: GetTickets200Response = await getTickets(tenantId, userId, state, skip, limit);

getTranslations

Parameters

Name	Type	Required
namespace	string	Yes
component	string	Yes
locale	string	No
useFullTranslationIds	boolean	No

Response

Returns: GetTranslationsResponse

Example

getTranslations Example

Copy

const translationsDefault: GetTranslationsResponse = await getTranslations("payments", "checkout");
const translationsFrenchDetailed: GetTranslationsResponse = await getTranslations("payments", "checkout", "fr-FR", true);

uploadImage

Upload and resize an image

Parameters

Name	Type	Required
tenantId	string	Yes
file	Blob	Yes
sizePreset	SizePreset	No
urlId	string	No

Response

Returns: UploadImageResponse

Example

uploadImage Example

Copy

const tenantId: string = 'tenant-acme-42';
const file: Blob = new Blob([Uint8Array.from([137, 80, 78, 71, 13, 10])], { type: 'image/png' });
const sizePreset: SizePreset = { name: 'hero-lg', maxWidth: 1920, maxHeight: 1080 };
const urlId: string = 'homepage-hero-2026';
const result: UploadImageResponse = await uploadImage(tenantId, file, sizePreset, urlId);

getUserBadgeProgressById

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

Response

Returns: GetUserBadgeProgressById200Response

Example

getUserBadgeProgressById Example

Copy

const tenantId: string = 'acme-corp';
const id: string = 'user-6f3a2b';
const includeHistory: boolean | undefined = true; // optional parameter example
const result: GetUserBadgeProgressById200Response = await getUserBadgeProgressById(tenantId, id);

getUserBadgeProgressByUserId

Parameters

Name	Type	Required	Description
tenantId	string	Yes
userId	string	Yes

Response

Returns: GetUserBadgeProgressById200Response

Example

getUserBadgeProgressByUserId Example

Copy

const tenantId: string = 'acme-enterprises';
const userId: string = 'user_9f2b3c';
const result: GetUserBadgeProgressById200Response = await getUserBadgeProgressByUserId(tenantId, userId);
console.log(result);

getUserBadgeProgressList

Parameters

Name	Type	Required
tenantId	string	Yes
userId	string	No
limit	number	No
skip	number	No

Response

Returns: GetUserBadgeProgressList200Response

Example

getUserBadgeProgressList Example

Copy

const tenantId: string = 'tenant_7f1a2b3c';
const userId: string = 'user_9f8e7d6c';
const limit: number = 25;
const skip: number = 0;
const result: GetUserBadgeProgressList200Response = await getUserBadgeProgressList(tenantId, userId, limit, skip);

createUserBadge

Parameters

Name	Type	Required	Description
tenantId	string	Yes
createUserBadgeParams	CreateUserBadgeParams	Yes

Response

Returns: CreateUserBadge200Response

Example

createUserBadge Example

Copy

const tenantId: string = "tenant_7f9b3";
const createUserBadgeParams: CreateUserBadgeParams = {
  userId: "user_8421",
  badge: {
    id: "badge_12",
    title: "Expert Contributor",
    description: "Awarded for 100 helpful answers"
  },
  notify: true
} as CreateUserBadgeParams;
const result: CreateUserBadge200Response = await createUserBadge(tenantId, createUserBadgeParams);

deleteUserBadge

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

Response

Returns: UpdateUserBadge200Response

Example

deleteUserBadge Example

Copy

(async () => {
  const tenantId: string = 'olympus_inc';
  const id: string = 'badge-73a9b2';
  const includeDetails: boolean | undefined = true;
  const response: UpdateUserBadge200Response = await deleteUserBadge(tenantId, id);
  console.log(response);
})();

getUserBadge

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

Response

Returns: GetUserBadge200Response

Example

getUserBadge Example

Copy

const tenantId: string = 'acme-enterprises-01';
const id: string = 'badge_8f3d2c';
const userBadgeResponse: GetUserBadge200Response = await getUserBadge(tenantId, id);

getUserBadges

Parameters

Name	Type	Required
tenantId	string	Yes
userId	string	No
badgeId	string	No
type	number	No
displayedOnComments	boolean	No
limit	number	No
skip	number	No

Response

Returns: GetUserBadges200Response

Example

getUserBadges Example

Copy

(async () => {
  const tenantId: string = 'acme-tenant-01';
  const userId: string | undefined = 'user_9876';
  const badgeId: string | undefined = undefined;
  const typeParam: number | undefined = 2;
  const displayedOnComments: boolean | undefined = true;
  const limit: number | undefined = 50;
  const skip: number | undefined = 0;
  const result: GetUserBadges200Response = await getUserBadges(tenantId, userId, badgeId, typeParam, displayedOnComments, limit, skip);
  console.log(result);
})();

updateUserBadge

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	Yes
updateUserBadgeParams	UpdateUserBadgeParams	Yes

Response

Returns: UpdateUserBadge200Response

Example

updateUserBadge Example

Copy

const tenantId: string = "acme-corp-tenant-01";
const id: string = "user_81234";
const updateUserBadgeParams: UpdateUserBadgeParams = {
  badgeId: "top_contributor",
  title: "Top Contributor",
  description: "Awarded for sustained high-quality community contributions",
  expiresAt: "2026-12-31T23:59:59Z" // optional parameter demonstrated
} as UpdateUserBadgeParams;
const result: UpdateUserBadge200Response = await updateUserBadge(tenantId, id, updateUserBadgeParams);

getUserNotificationCount

Parameters

Name	Type	Required	Description
tenantId	string	Yes
sso	string	No

Response

Returns: GetUserNotificationCount200Response

Example

getUserNotificationCount Example

Copy

const tenantId: string = 'a1b2c3d4-5678-90ab-cdef-1234567890ab';
const resultWithoutSSO: GetUserNotificationCount200Response = await getUserNotificationCount(tenantId);
const ssoToken: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI1Njc4OSIsImlhdCI6MTYwOTAwMDAwMH0.signature';
const resultWithSSO: GetUserNotificationCount200Response = await getUserNotificationCount(tenantId, ssoToken);

getUserNotifications

Parameters

Name	Type	Required
tenantId	string	Yes
pageSize	number	No
afterId	string	No
includeContext	boolean	No
afterCreatedAt	number	No
unreadOnly	boolean	No
dmOnly	boolean	No
noDm	boolean	No
includeTranslations	boolean	No
sso	string	No

Response

Returns: GetUserNotifications200Response

Example

getUserNotifications Example

Copy

const response: GetUserNotifications200Response = await getUserNotifications(
  'tenant_8f3a12',
  25,
  'notif_4b2d1',
  true,
  Date.now() - 7 * 24 * 60 * 60 * 1000,
  true,
  undefined,
  undefined,
  true,
  'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyXzEyMyIsImlhdCI6MTY4MDAwMDAwMH0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'
);

resetUserNotificationCount

Parameters

Name	Type	Required	Description
tenantId	string	Yes
sso	string	No

Response

Returns: ResetUserNotifications200Response

Example

resetUserNotificationCount Example

Copy

(async () => {
  const tenantId: string = 'acme-tenant-78f3';
  const noSsoResult: ResetUserNotifications200Response = await resetUserNotificationCount(tenantId);
  const ssoToken: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
  const withSsoResult: ResetUserNotifications200Response = await resetUserNotificationCount(tenantId, ssoToken);
  console.log(noSsoResult, withSsoResult);
})();

resetUserNotifications

Parameters

Name	Type	Required
tenantId	string	Yes
afterId	string	No
afterCreatedAt	number	No
unreadOnly	boolean	No
dmOnly	boolean	No
noDm	boolean	No
sso	string	No

Response

Returns: ResetUserNotifications200Response

Example

resetUserNotifications Example

Copy

const params: {
  tenantId: string;
  afterId?: string;
  afterCreatedAt?: number;
  unreadOnly?: boolean;
  dmOnly?: boolean;
  noDm?: boolean;
  sso?: string;
} = {
  tenantId: 'tenant_7f3b9c',
  afterId: 'notif_20260520_01',
  afterCreatedAt: Date.now() - 3_600_000,
  unreadOnly: true,
  sso: 'sso_session_xyz'
};
const result: ResetUserNotifications200Response = await resetUserNotifications(params);

updateUserNotificationCommentSubscriptionStatus

Enable or disable notifications for a specific comment.

Parameters

Name	Type	Required
tenantId	string	Yes
notificationId	string	Yes
optedInOrOut	UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum	Yes
commentId	string	Yes
sso	string	No

Response

Returns: UpdateUserNotificationStatus200Response

Example

updateUserNotificationCommentSubscriptionStatus Example

Copy

const tenantId: string = 'tenant_12345';
const notificationId: string = 'notif_98765';
const commentId: string = 'cmt_54321';
const optedInOrOut: UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum = UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum.OptedIn;
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
const result: UpdateUserNotificationStatus200Response = await updateUserNotificationCommentSubscriptionStatus(tenantId, notificationId, optedInOrOut, commentId, sso);

updateUserNotificationPageSubscriptionStatus

Enable or disable notifications for a page. When users are subscribed to a page, notifications are created for new root comments, and also

Parameters

Name	Type	Required
tenantId	string	Yes
urlId	string	Yes
url	string	Yes
pageTitle	string	Yes
subscribedOrUnsubscribed	UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum	Yes
sso	string	No

Response

Returns: UpdateUserNotificationStatus200Response

Example

updateUserNotificationPageSubscriptionStatus Example

Copy

const tenantId: string = 'acme-tenant-001';
const urlId: string = 'kb-article-421';
const url: string = 'https://support.acme.com/kb/configuring-single-sign-on';
const pageTitle: string = 'Configuring Single Sign-On for Support Portal';
const subscribedOrUnsubscribed: UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum =
  UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum.Subscribed;
const sso: string = 'saml:acme-tenant-001';
const result: UpdateUserNotificationStatus200Response =
  await updateUserNotificationPageSubscriptionStatus(tenantId, urlId, url, pageTitle, subscribedOrUnsubscribed, sso);

updateUserNotificationStatus

Parameters

Name	Type	Required
tenantId	string	Yes
notificationId	string	Yes
newStatus	UpdateUserNotificationStatusNewStatusEnum	Yes
sso	string	No

Response

Returns: UpdateUserNotificationStatus200Response

Example

updateUserNotificationStatus Example

Copy

const tenantId: string = 'd8f4a2b0-6b3e-4c9a-9f1a-1234567890ab';
const notificationId: string = 'notif-20260520-001';
const newStatus: UpdateUserNotificationStatusNewStatusEnum = UpdateUserNotificationStatusNewStatusEnum.Read;
const sso: string = 'sso-token-7f3b9c';
const result: UpdateUserNotificationStatus200Response = await updateUserNotificationStatus(tenantId, notificationId, newStatus, sso);

getUserPresenceStatuses

Parameters

Name	Type	Required
tenantId	string	Yes
urlIdWS	string	Yes
userIds	string	Yes

Response

Returns: GetUserPresenceStatuses200Response

Example

getUserPresenceStatuses Example

Copy

const tenantId: string = "9f8b7c6d-1234-4b2a-9d8e-0a1b2c3d4e5f";
const urlIdWS: string = "wss://presencews.prod.company.example.com/stream";
const userIds: string = "a3e9b1f0-1111-4444-8888-1234567890ab,c2d3e4f5-2222-5555-9999-abcdefabcdef";
const includeOffline: boolean | undefined = true;
const result: GetUserPresenceStatuses200Response = await getUserPresenceStatuses(tenantId, urlIdWS, userIds);

searchUsers

Parameters

Name	Type	Required
tenantId	string	Yes
urlId	string	Yes
usernameStartsWith	string	No
mentionGroupIds	Array	No
sso	string	No
searchSection	SearchUsersSearchSectionEnum	No

Response

Returns: SearchUsers200Response

Example

searchUsers Example

Copy

const tenantId: string = 'acme-corp';
const urlId: string = 'site-2026';
const usernameStartsWith: string = 'mar';
const mentionGroupIds: Array<string> = ['engineering', 'product-design'];
const sso: string = 'saml';
const result: SearchUsers200Response = await searchUsers(tenantId, urlId, usernameStartsWith, mentionGroupIds, sso);

getUser

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

Response

Returns: GetUser200Response

Example

getUser Example

Copy

const idSuffix: string | undefined = undefined;
const tenantId: string = "acme-enterprises";
const id: string = idSuffix ?? "user_98765";
const response: GetUser200Response = await getUser({ tenantId, id });

createVote

Parameters

Name	Type	Required
tenantId	string	Yes
commentId	string	Yes
direction	CreateVoteDirectionEnum	Yes
userId	string	No
anonUserId	string	No

Response

Returns: VoteComment200Response

Example

createVote Example

Copy

const tenantId: string = 'tenant_6a1b2c';
const commentId: string = 'cmt_d4e5f6';
const direction: CreateVoteDirectionEnum = 'UP' as CreateVoteDirectionEnum;
const userId: string = 'user_93b7a1';
const result: VoteComment200Response = await createVote(tenantId, commentId, direction, userId);

deleteVote

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	Yes
editKey	string	No

Response

Returns: DeleteCommentVote200Response

Example

deleteVote Example

Copy

const tenantId: string = 'tenant_8b3f2a9c';
const id: string = 'comment-4721';
const editKey: string = 'edk_4f2a9b7c';
const responseWithEditKey: DeleteCommentVote200Response = await deleteVote(tenantId, id, editKey);
const responseWithoutEditKey: DeleteCommentVote200Response = await deleteVote(tenantId, id);

getVotes

Parameters

Name	Type	Required	Description
tenantId	string	Yes
urlId	string	Yes

Response

Returns: GetVotes200Response

Example

getVotes Example

Copy

const tenantId: string = 'tenant-42c-eu';
const urlId: string = 'article-7f9b';
const includeMetadata: boolean | undefined = true;
const votes: GetVotes200Response = await getVotes(tenantId, urlId);

getVotesForUser

Parameters

Name	Type	Required
tenantId	string	Yes
urlId	string	Yes
userId	string	No
anonUserId	string	No

Response

Returns: GetVotesForUser200Response

Example

getVotesForUser Example

Copy

const tenantId: string = 'acme-tenant-42';
const urlId: string = 'release-notes';
const userId: string = 'user_10293';
const votes: GetVotesForUser200Response = await getVotesForUser(tenantId, urlId, userId);

Need Help?

If you encounter any issues or have questions about the JavaScript/TypeScript SDK, please:

Contributing

Contributions are welcome! Please visit the GitHub repository for contribution guidelines.

Language 🇺🇸 English

Getting Started

API Reference

Documentation

Usage

Aggregate

Audit Logs

Block From Comment

Check Blocked Comments

Comments

Comments For User

Domain Configs

Email Templates

Event Log

Feed Posts

Flag Comment

Gifs

Hash Tags

Moderators

Notification Count

Notifications

Pages

Pending Webhook Events

Question Configs

Question Results

Question Results Aggregation

SSO Users

Subscriptions

Tenant Daily Usage

Tenant Packages

Tenant Users

Tenants

Tickets

Translations

Upload Image

User Badge Progress

User Badges

User Notifications

User Presence Status

User Search

Users

Votes

FastComments JavaScript/TypeScript SDK

Repository

Installation

API Documentation

Browser vs Server Compatibility

Usage

Browser Usage (Client-Side)

Server Usage (Node.js)

Types Only Import

Using Individual API Classes

Browser Environment

Server Environment

Public vs Secured APIs

Example: Using Public API (browser-safe)

Example: Using Default API (server-side only)

SSO (Single Sign-On) Integration

Simple SSO (Server-Side Only)

Secure SSO (Server-Side, Recommended)

Using SSO from Browser (with Server-Generated Token)

SSO with Comment Creation

Common Use Cases

Getting Comments for a Page

Creating a Comment

Voting on a Comment

User Management (Requires API Key)

Live Events (Real-time Updates)

Page-Level Events

Subscribe to User Events

Getting userIdWS

Broadcast IDs

Error Handling

aggregate

Parameters

Response

Example

getAuditLogs

Parameters

Response