FastComments JavaScript/TypeScript SDK

This is the official JavaScript/TypeScript SDK for FastComments.

Official JavaScript/TypeScript SDK for the FastComments API

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);
  }
}

TypeScript Support

The SDK is written in TypeScript and provides complete type definitions for all API methods and response models:

// Import types from the default export (safe everywhere)
import type { 
  PublicComment, 
  CreateCommentParams, 
  GetCommentsPublic200Response 
} from 'fastcomments-sdk';

// Use with browser SDK
import { createFastCommentsBrowserSDK } from 'fastcomments-sdk/browser';

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

const comments: PublicComment[] = response.comments || [];

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_tenant_001';
const parentTenantId: string = 'acme_global_parent';
const includeStats: boolean = true;
const aggregationRequest: AggregationRequest = {
  predicates: [
    { field: 'status', operator: 'eq', value: 'published' } as QueryPredicate
  ],
  operations: [
    { opType: 'count', field: 'commentId', alias: 'totalComments' } as AggregationOperation,
    { opType: 'group_by', field: 'threadId', alias: 'commentsByThread', limit: 10 } as AggregationOperation
  ],
  sort: [{ field: 'totalComments', direction: 'desc' }] as AggregationRequestSort[],
  limit: 100
};
const result: 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 = '3fa85f64-5717-4562-b3fc-2c963f66afa6';
const limit: number = 100;
const skip: number = 0;
const order: SORTDIR = ("DESC" as unknown) as SORTDIR;
const after: number = Date.now() - 1000 * 60 * 60 * 24 * 30; // 30 days ago
const before: number = Date.now();
const result: 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_8f4b2a';
const commentId: string = 'cmt_92a7f1';
const publicBlockFromCommentParams: PublicBlockFromCommentParams = {
  reason: 'Repeated phishing links',
  durationHours: 168,
  blockUser: true
} as PublicBlockFromCommentParams;
const ssoToken: string = 'sso:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
const response: BlockFromCommentPublic200Response = await blockFromCommentPublic(tenantId, commentId, publicBlockFromCommentParams, ssoToken);

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_42";
const commentId: string = "cmt_7d1f3e9b";
const publicBlockFromCommentParams: PublicBlockFromCommentParams = {
  reason: "false positive moderation",
  moderatorId: "mod-47",
  reviewedAt: "2025-11-04T10:15:00Z"
};
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.exampleSignature";
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 = "tenant_prod_84a2";
const commentIds: string = "cmt-112233,cmt-445566";
const ssoToken: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sso.signature";
const resultWithoutSSO: CheckedCommentsForBlocked200Response = await checkedCommentsForBlocked(tenantId, commentIds);
const resultWithSSO: CheckedCommentsForBlocked200Response = await checkedCommentsForBlocked(tenantId, commentIds, ssoToken);

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_5f8b9a2c';
const id: string = 'cmt_0123456789abcdef';
const blockFromCommentParams: BlockFromCommentParams = {
  reason: 'Repeated abusive language',
  durationHours: 72,
  notifyModerators: true,
  applyToThread: false
};
const userId: string | undefined = 'user_42';
const anonUserId: string | undefined = undefined;
const response: BlockFromCommentPublic200Response = await blockUserFromComment(tenantId, id, blockFromCommentParams, userId, anonUserId);

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_prod_us_east_01';
const urlId: string = 'news-site/article/2025/11/04/12345';
const broadcastId: string = 'broadcast_live_20251104_01';
const commentData: CommentData = {
  text: 'Excellent analysis — the timeline and sources clarified a lot. Curious about next steps for the investigation.',
  authorName: 'Jordan Miles',
  authorAvatarUrl: 'https://cdn.example.com/avatars/jordan.jpg',
  mentions: [{ userId: 'user_10234', displayName: 'Alex R.' }],
  metadata: { region: 'us-east', contentType: 'comment' }
};
const sessionId: string = 'sess_ab12cd34ef';
const sso: string = 'sso_token_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

const tenantId: string = 'f47ac10b-58cc-4372-a567-0e02b2c3d479';
const commentId: string = 'a1b2c3d4-e5f6-47b8-9c0d-123456789abc';
const contextUserId: string = '9f8e7d6c-5b4a-3210-fedc-ba9876543210';
const result: DeleteComment200Response = await deleteComment(tenantId, commentId, contextUserId, true);

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_acme_42';
const commentId: string = 'cmt_7f3b2a1e';
const broadcastId: string = 'broadcast_homepage_en-us';
const editKey: string | undefined = 'edit_9a8b7c6d';
const sso: string | undefined = 'sso_jwt_eyJhbGciOiJIUzI1Ni';
const response: 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_9f2a3b";
const commentId: string = "cmt-8f3a2b";
const voteId: string = "vot-20251104-01";
const urlId: string = "article-2025-11-04-homepage";
const broadcastId: string = "live-embed-01";
const editKey: string = "edk-6a7b8c9d"; // optional
const sso: string | undefined = undefined; // optional, omitted in this call
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_8a3b2c1d';
const commentId: string = 'cmt_5f7e3a9b';
const userId: string | undefined = 'user_42f1a';
const anonUserId: string | undefined = 'anon_e2c3f1';
const result: FlagComment200Response = await flagComment(tenantId, commentId, userId, anonUserId);

getComment

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

Response

Returns: GetComment200Response

Example

getComment Example

Copy

const tenantId: string = 'org-534ac2';
const commentId: string = 'cmt-9d7f2b44-1a2b-4c3d-9e8f-123456789abc';
const requestedFields: PickFCommentAPICommentFieldsKeys[] | undefined = ['body', 'user']; // optional selection
const result: GetComment200Response = await getComment(tenantId, commentId);

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 = "fc_tenant_79b";
const page: number = 2;
const limit: number = 50;
const skip: number = 0;
const asTree: boolean = true;
const maxTreeDepth: number = 3;
const urlId: string = "https://example.com/articles/performance-tips";
const userId: string = "user_42";
const anonUserId: string = "anon_7a9";
const direction: SortDirections = ("desc" as unknown) as SortDirections;
const response: GetComments200Response = await getComments(
  tenantId,
  page,
  limit,
  skip,
  asTree,
  undefined,
  undefined,
  maxTreeDepth,
  urlId,
  userId,
  anonUserId,
  undefined,
  "release-2025",
  undefined,
  direction
);

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-tenant-01';
const urlId: string = 'blog/2025/launch-announcement';
const page: number = 1;
const direction: SortDirections = ('desc' as unknown) as SortDirections;
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature';
const limit: number = 25;
const limitChildren: number = 5;
const countChildren: boolean = true;
const includeConfig: boolean = true;
const asTree: boolean = true;
const maxTreeDepth: number = 3;
const searchText: string = 'performance improvements';
const hashTags: Array<string> = ['release', 'performance'];
const userId: string = 'user_8421';
const response: GetCommentsPublic200Response = await getCommentsPublic(
  tenantId,
  urlId,
  page,
  direction,
  sso,
  undefined,
  undefined,
  limit,
  limitChildren,
  countChildren,
  undefined,
  includeConfig,
  undefined,
  undefined,
  undefined,
  undefined,
  undefined,
  undefined,
  asTree,
  maxTreeDepth,
  undefined,
  undefined,
  searchText,
  hashTags,
  userId,
  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

(async () => {
  const tenantId: string = "acme-publishing-42";
  const commentId: string = "cmt_20251104_9f3b2a";
  const responseWithoutEdit: GetCommentText200Response = await getCommentText(tenantId, commentId);
  const editKey: string = "edK_7b2f9a";
  const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"; 
  const responseWithEditAndSSO: GetCommentText200Response = await getCommentText(tenantId, commentId, editKey, sso);
  console.log(responseWithoutEdit, responseWithEditAndSSO);
})();

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 = "f7a8b9c0-1234-5678-90ab-cdef12345678";
const commentId: string = "d3b07384-d9f1-4c2b-9f2e-8a7c6f1e2b9a";
const dir: number = 1;
const ssoToken: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.fake.payload";
const resultWithoutSSO: GetCommentVoteUserNames200Response = await getCommentVoteUserNames(tenantId, commentId, dir);
const resultWithSSO: GetCommentVoteUserNames200Response = await getCommentVoteUserNames(tenantId, commentId, dir, ssoToken);

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_4f2b3c1a';
const commentId: string = 'cmt_5d21a9f3';
const broadcastId: string = 'broadcast_newsroom_2025-11-04';
const resultWithoutSSO: LockComment200Response = await lockComment(tenantId, commentId, broadcastId);
const ssoToken: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyQGV4YW1wbGUuY29tIiwiaWF0IjoxNjM0ODAwMDB9.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
const resultWithSSO: LockComment200Response = await lockComment(tenantId, commentId, broadcastId, ssoToken);

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 = 'news-site-42';
const commentId: string = 'c7a8b9f2-3d5b-4e6f-9a1b-2c3d4e5f6a7b';
const broadcastId: string = 'live-sports-2025-11-04-nyc';
const ssoToken: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature';
const pinned: PinComment200Response = await pinComment(tenantId, commentId, broadcastId);
const pinnedWithSso: PinComment200Response = await pinComment(tenantId, commentId, broadcastId, ssoToken);

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 = 'tenant_9b4c1f';
const createCommentParams: CreateCommentParams = ({
  content: 'I enjoyed this article — the examples were very helpful.',
  authorName: 'Jamie R.',
  authorEmail: 'jamie.r@example.com',
  parentId: null,
  metadata: { articleId: 'art_4521', section: 'comments' }
} as CreateCommentParams);
const result: SaveComment200Response = await saveComment(tenantId, createCommentParams, true, true, false, 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_acme_7649";
const createCommentParams: Array<CreateCommentParams> = [
  {
    threadId: "article-2025-cloud-costs",
    text: "Great breakdown — saved me hours. Note: reserved instance math seems off for multi-AZ.",
    authorName: "Jordan Lee",
    authorEmail: "jordan.lee@acme.co",
    createdAt: "2025-11-04T10:15:00Z",
    mentions: [{ userId: "u_12345", username: "samuel.t" }],
    hashtags: [{ tag: "cloud-costs" }]
  },
  {
    threadId: "product-release-q4",
    text: "Congrats team! I left a couple UX notes in the doc linked below.",
    authorName: "Priya Nair",
    authorEmail: "priya@startup.io",
    parentId: "c_98765",
    mentions: [{ userId: "u_67890", username: "devops" }],
    hashtags: [{ tag: "release" }]
  }
];
const isLive: boolean = true;
const doSpamCheck: boolean = true;
const sendEmails: boolean = false;
const populateNotifications: boolean = true;
const responses: Array<SaveComment200Response> = await saveCommentsBulk(tenantId, createCommentParams, isLive, doSpamCheck, sendEmails, 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_acme_corp';
const commentId: string = 'cmt-987654321';
const broadcastId: string = 'article-2025-11-04-hero';
const commentTextUpdateRequest: CommentTextUpdateRequest = {
  text: 'Thanks — I updated this with a correction and a follow-up question for clarity.',
  mentions: [{ userId: 'usr_102', displayName: 'Ava Lee' } as CommentUserMentionInfo],
  hashtags: [{ tag: 'policy', startIndex: 68 } as CommentUserHashTagInfo]
};
const editKey: string = 'editKey_7f4d2';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature';
const result: SetCommentText200Response = await setCommentText(
  tenantId,
  commentId,
  broadcastId,
  commentTextUpdateRequest,
  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-prod-51';
const id: string = 'cmt_20251104_0001';
const unBlockFromCommentParams: UnBlockFromCommentParams = {
  reason: 'Appeal accepted after review',
  moderatorId: 'mod_42',
  unblockedAt: new Date().toISOString()
};
const userId: string = 'user_10089';
const anonUserId: string = 'anon_7f3b';
const result: UnBlockCommentPublic200Response = await unBlockUserFromComment(tenantId, id, unBlockFromCommentParams, userId, anonUserId);

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 unflagResultLoggedIn: FlagComment200Response = await unFlagComment("tenant_3d9f2a_eu", "cmt_84b1f3", "user_1074");
const unflagResultAnon: FlagComment200Response = await unFlagComment("tenant_3d9f2a_eu", "cmt_84b1f3", undefined, "anon_9x7y2");

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 = 'acme-media-tenant-77';
const commentId: string = 'cmt_9f8b3a6d';
const broadcastId: string = 'live_2025-11-04_nightly-show';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.ssoPayload.signature';
const unlockedWithSSO: LockComment200Response = await unLockComment(tenantId, commentId, broadcastId, sso);
const unlockedWithoutSSO: LockComment200Response = await unLockComment(tenantId, commentId, broadcastId);

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_82f5a3';
const commentId: string = 'cmt_9a1b4d';
const broadcastId: string = 'brd_3f2e9c';
const ssoToken: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.ssoPayload.signature';
const responseWithSso: PinComment200Response = await unPinComment(tenantId, commentId, broadcastId, ssoToken);
const responseWithoutSso: PinComment200Response = await unPinComment(tenantId, commentId, broadcastId);

updateComment

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	Yes
body	PickAPICommentUpdatableCommentFields	Yes
contextUserId	string	No
doSpamCheck	boolean	No
isLive	boolean	No

Response

Returns: FlagCommentPublic200Response

Example

updateComment Example

Copy

const tenantId: string = 'acme-corp-tenant-72';
const id: string = 'cmt_9a7f6b3e';
const body: PickAPICommentUpdatableCommentFields = {
  content: 'We fixed the formatting issue; thanks for reporting.',
  isVisible: true,
  metadata: { editedBy: 'moderator_jane', editReason: 'clarified wording' }
};
const contextUserId: string = 'moderator_jane';
const doSpamCheck: boolean = true;
const isLive: boolean = false;
const result: FlagCommentPublic200Response = await updateComment(tenantId, id, body, 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_4f2b9a';
const commentId: string = 'cmt_00012345';
const urlId: string = 'news/2025/11/04/ai-impact';
const broadcastId: string = 'bcast_3a9f2d';
const voteBodyParams: VoteBodyParams = { direction: 'up', weight: 1 };
const sessionId: string = 'sess_9f8e7d6c';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.signed';
const result: VoteComment200Response = await voteComment(tenantId, commentId, urlId, broadcastId, voteBodyParams, sessionId, sso);

addDomainConfig

Parameters

Name	Type	Required	Description
tenantId	string	Yes
addDomainConfigParams	AddDomainConfigParams	Yes

Response

Returns: AddDomainConfig200Response

Example

addDomainConfig Example

Copy

const tenantId: string = "tenant_8f3c2a1b";
const addDomainConfigParams: AddDomainConfigParams = {
  domain: "discuss.myproduct.com",
  cname: "fc-myproduct-comments.svc.fastcomments.net",
  allowSubdomains: true,        // optional
  enforceHttps: true            // optional
};
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 = 'tenant_01a2b3c4';
const primaryDomain: string = 'comments.acme-corp.com';
let optionalSubdomain: string | undefined = undefined; // optional override when present
const domainToDelete: string = optionalSubdomain ?? primaryDomain;
const response: DeleteDomainConfig200Response = await deleteDomainConfig(tenantId, domainToDelete);

getDomainConfig

Parameters

Name	Type	Required	Description
tenantId	string	Yes
domain	string	Yes

Response

Returns: GetDomainConfig200Response

Example

getDomainConfig Example

Copy

const tenantId: string = 'acme-tenant-42';
const defaultDomain: string = 'comments.acme.com';
const domainOverride: string | undefined = undefined;
const domain: string = domainOverride ?? defaultDomain;
const result: GetDomainConfig200Response = await getDomainConfig(tenantId, domain);
console.log(result);

getDomainConfigs

Parameters

Name	Type	Required	Description
tenantId	string	Yes

Response

Returns: GetDomainConfigs200Response

Example

getDomainConfigs Example

Copy

const tenantId: string = "tenant_4f3b9a-west-1";
const options: { includeDisabled?: boolean; environment?: "production" | "staging" } = { includeDisabled: true, environment: "production" };
const response: GetDomainConfigs200Response = await getDomainConfigs(tenantId, options);

patchDomainConfig

Parameters

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

Response

Returns: GetDomainConfig200Response

Example

patchDomainConfig Example

Copy

const tenantId: string = "tenant_4f9d2a7c";
const domainToUpdate: string = "comments.example-site.com";
const patchDomainConfigParams: PatchDomainConfigParams = {
  enabled: true,
  enforceHttps: true, // optional parameter demonstrated
  allowedOrigins: ["https://www.example.com"],
  primary: false
};
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 = 'acme-corp-9f2b';
const domainToUpdate: string = 'comments.acme.com';
const updateDomainConfigParams: UpdateDomainConfigParams = {
  primaryHost: 'comments.acme.com',
  routeType: 'subdomain',
  enableSsl: true,
  sslCertificateId: undefined, // optional: left undefined to let system provision certificate
  redirectToPrimaryHost: true,
  allowedOrigins: ['https://www.acme.com', 'https://blog.acme.com']
};
const result: GetDomainConfig200Response = await putDomainConfig(tenantId, domainToUpdate, updateDomainConfigParams);

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 = 'tenant_8a4b2';
const urlId: string = 'articles/2025/11/fastcomments-typescript-example';
const maybeStartTime: number | undefined = undefined; // optional start time (demonstration)
const startTime: number = maybeStartTime ?? Date.now() - 1000 * 60 * 60; // default to 1 hour ago
const endTime: number = Date.now();
const userIdWS: string = 'ws_user_789';
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

(async () => {
  const tenantId: string = 'tenant_ab12cd34';
  const urlId: string = 'url_9f8e7d6c';
  const userIdWS: string = 'ws_user_5721';
  const startTimeOverride: number | undefined = undefined; // optional override
  const startTime: number = startTimeOverride ?? Date.now() - 7 * 24 * 60 * 60 * 1000; // last 7 days
  const endTime: number = Date.now();
  const response: GetEventLog200Response = await getGlobalEventLog(tenantId, urlId, userIdWS, startTime, endTime);
  console.log(response);
})();

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_ab12cd34';
const createFeedPostParams: CreateFeedPostParams = {
  title: 'Product update: threaded replies',
  body: 'We’ve released threaded replies to improve conversations. Check the examples and migration notes.',
  media: [{ type: 'image', assets: [{ url: 'https://cdn.fastcomments.com/releases/threaded.png', mimeType: 'image/png' }] } as FeedPostMediaItem],
  links: [{ url: 'https://fastcomments.com/blog/threaded-replies', title: 'Read the full release notes' } as FeedPostLink]
};
const broadcastId: string = 'broadcast_2025_11_04';
const isLive: boolean = true;
const doSpamCheck: boolean = true;
const skipDupCheck: boolean = false;
const result: CreateFeedPost200Response = await createFeedPost(tenantId, createFeedPostParams, broadcastId, isLive, doSpamCheck, skipDupCheck);

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_acme_corp_123';
const createFeedPostParams: CreateFeedPostParams = {
  title: 'Aurora 2.0 Launch',
  body: "We're excited to announce Aurora 2.0 — faster load times and improved accessibility.",
  links: [{ url: 'https://acme.example.com/aurora-2-release', title: 'Read release notes' }],
  media: [{ type: 'image', assets: [{ url: 'https://cdn.example.com/aurora2-hero.jpg', mimeType: 'image/jpeg' }] }],
  visibility: 'public',
  tags: ['release', 'product'],
  allowComments: true,
  authorId: 'user_987'
};
const broadcastId: string = 'broadcast_2025_11_04_01';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.exampleSignature';
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 = "tenant_82f7c3";
const postId: string = "post_5b9a1f2a";
const broadcastId: string = "broadcast_9f3d2b";
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1aWQiOiI0NTY3OCIsImlhdCI6MTYxNjI3MjAwMH0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
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_84f2b1';
const afterId: string = 'post_000123';
const limit: number = 25;
const tags: Array<string> = ['breaking-news', 'release'];
const feedResponse: GetFeedPosts200Response = await getFeedPosts(tenantId, afterId, limit, tags);
const minimalResponse: GetFeedPosts200Response = await getFeedPosts('tenant_84f2b1');

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 tenantId: string = 'tenant_8421';
const afterId: string = 'post_20251101_007';
const limit: number = 20;
const tags: string[] = ['technology', 'product-launch'];
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sso_payload.signature';
const isCrawler: boolean = false;
const includeUserInfo: boolean = true;
const response: GetFeedPostsPublic200Response = await getFeedPostsPublic(tenantId, afterId, limit, tags, sso, isCrawler, includeUserInfo);

getFeedPostsStats

Parameters

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

Response

Returns: GetFeedPostsStats200Response

Example

getFeedPostsStats Example

Copy

const tenantId: string = 'acme-corp-7';
const postIds: string[] = [
  'd4f1c3b2-6a9e-4a8b-9cde-0f1a2b3c4d5e',
  'b2e1d0c3-5f6a-4b7c-8d9e-1a2b3c4d5e6f'
];
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.exampleSignature';
const statsNoSSO: GetFeedPostsStats200Response = await getFeedPostsStats(tenantId, postIds);
const statsWithSSO: GetFeedPostsStats200Response = await getFeedPostsStats(tenantId, postIds, sso);

getUserReactsPublic

Parameters

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

Response

Returns: GetUserReactsPublic200Response

Example

getUserReactsPublic Example

Copy

const tenantId: string = 'tenant_8b3f7c2a';
const postIds: Array<string> = ['post_6f4d2a1b', 'post_9c8e1d3f'];
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI0MjMiLCJ0ZW5hbnQiOiJ0ZW5hbnRfOGIzZjdhIn0.signature';
const result: 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
sso	string	No

Response

Returns: ReactFeedPostPublic200Response

Example

reactFeedPostPublic Example

Copy

const tenantId: string = 'tenant_acme_inc';
const postId: string = 'post_2025_98765';
const reactBodyParams: ReactBodyParams = { reactionType: 'heart', userId: 'user_712', source: 'web' };
const isUndo: boolean = false;
const broadcastId: string = 'bcast-3f7a9d2c';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyXzcxMiJ9.signature';
const result: ReactFeedPostPublic200Response = await reactFeedPostPublic(tenantId, postId, reactBodyParams, isUndo, broadcastId, 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-corp-9f3d";
const id: string = "post_20251104_9876";
const scheduledAt: string | undefined = undefined; // optional scheduling parameter
const feedPost: FeedPost = {
  title: "Q4 Product Roadmap & Priorities",
  content: "Focus areas: stability, onboarding, and performance improvements across web and mobile.",
  authorId: "user_84",
  published: true,
  tags: ["roadmap", "q4", "product"],
  media: [
    {
      id: "media_01",
      type: "image",
      assets: [{ url: "https://cdn.acme.com/roadmap-q4.png", mimeType: "image/png", width: 1200, height: 800 }]
    }
  ],
  links: [{ title: "Full changelog", url: "https://acme.com/changelog/q4" }],
  scheduledAt
};
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_2025-11-04_9f2b';
const updateFeedPostParams: UpdateFeedPostParams = {
  title: 'Weekly Product Update',
  body: 'Released search relevance improvements and bug fixes. Thanks to everyone who reported issues.',
  isPublished: true,
  tags: ['release', 'search'],
  media: [{ url: 'https://cdn.acme-corp.com/images/update-2025-11-04.jpg', type: 'image' } as FeedPostMediaItem],
};
const broadcastId: string = 'broadcast_20251104_01';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature';
const response: 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 = "tenant_42a7c";
const commentId: string = "cmt_a7b9c3d2e4";
const isFlagged: boolean = true;
const ssoToken: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyOjEyMyIsImlhdCI6MTYwOTAwMDAwMH0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
const resultWithSSO: FlagCommentPublic200Response = await flagCommentPublic(tenantId, commentId, isFlagged, ssoToken);
const resultWithoutSSO: FlagCommentPublic200Response = await flagCommentPublic(tenantId, commentId, false);

addPage

Parameters

Name	Type	Required	Description
tenantId	string	Yes
createAPIPageData	CreateAPIPageData	Yes

Response

Returns: AddPageAPIResponse

Example

addPage Example

Copy

async function run(): Promise<void> {
  const tenantId: string = 'acme-tenant-us-east-1';
  const createAPIPageData: CreateAPIPageData = {
    url: 'https://blog.acme.com/product/2025/11/04/new-release',
    title: 'Acme Product — November 2025 Release',
    language: 'en-US',
    tags: ['release', 'product'],
    canonicalUrl: 'https://acme.com/blog/new-release-2025-11-04', // optional
    allowComments: true, // optional
    metadata: { author: 'Acme Engineering' } // optional
  };
  const response: AddPageAPIResponse = await addPage(tenantId, createAPIPageData);
  console.log(response);
}
run();

deletePage

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

Response

Returns: DeletePageAPIResponse

Example

deletePage Example

Copy

const tenantId: string = "acme-corp-7a2f";
const baseId: string = "page-2023-11-05-article-42";
const envSuffix: string | undefined = "-staging";
const id: string = envSuffix ? `${baseId}${envSuffix}` : baseId;
const result: DeletePageAPIResponse = await deletePage(tenantId, id);

getPageByURLId

Parameters

Name	Type	Required	Description
tenantId	string	Yes
urlId	string	Yes

Response

Returns: GetPageByURLIdAPIResponse

Example

getPageByURLId Example

Copy

const tenantId: string = 'tenant_7f4c2b9a';
const urlId: string = 'page_3b1f9a2c';
const result: GetPageByURLIdAPIResponse = await getPageByURLId(tenantId, urlId);
const pageTitle: string | undefined = (result as unknown as { page?: { title?: string } }).page?.title;

getPages

Parameters

Name	Type	Required	Description
tenantId	string	Yes

Response

Returns: GetPagesAPIResponse

Example

getPages Example

Copy

const tenantId: string = 'acme-tenant-9f4b2';
const options: { pageSize?: number; includeDrafts?: boolean; cursor?: string } = { pageSize: 25, includeDrafts: false };
const pages: 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

const tenantId: string = 'tenant-5f3b2a1c';
const id: string = 'page-7d2a9b4f';
const updateData: UpdateAPIPageData = {
  title: 'Single Sign-On (SSO) Integration',
  path: '/guides/sso/integration',
  isPublished: true,
  metadata: { author: 'Platform Docs', lastEdited: '2025-10-30' },
  redirectUrl: undefined // optional parameter demonstrated
};
const result: PatchPageAPIResponse = await patchPage(tenantId, id, updateData);

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_8f7d4';
const questionIds: string[] = ['q_42', 'q_43'];
const urlId: string = 'page_3a9';
const timeBucket: AggregateTimeBucket = 'monthly' as unknown as AggregateTimeBucket;
const startDate: Date = new Date('2025-01-01T00:00:00Z');
const forceRecalculate: boolean = true;
const result: AggregateQuestionResults200Response = await aggregateQuestionResults(tenantId, undefined, questionIds, urlId, timeBucket, startDate, forceRecalculate);

bulkAggregateQuestionResults

Parameters

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

Response

Returns: BulkAggregateQuestionResults200Response

Example

bulkAggregateQuestionResults Example

Copy

(async () => {
  const tenantId: string = 'tenant_4f3a2b1c';
  const forceRecalculate: boolean = true;
  const bulkAggregateQuestionResultsRequest: BulkAggregateQuestionResultsRequest = {
    items: [
      {
        questionId: 'question_9876',
        timeframe: { start: '2025-10-01T00:00:00Z', end: '2025-10-31T23:59:59Z' },
        buckets: [
          { start: '2025-10-01T00:00:00Z', end: '2025-10-07T23:59:59Z' },
          { start: '2025-10-08T00:00:00Z', end: '2025-10-15T23:59:59Z' }
        ]
      } as BulkAggregateQuestionItem
    ] as BulkAggregateQuestionItem[]
  };
  const result: BulkAggregateQuestionResults200Response = await bulkAggregateQuestionResults(tenantId, bulkAggregateQuestionResultsRequest, forceRecalculate);
  console.log(result);
})();

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_9b2f6c';
const questionIds: string[] = ['poll-2025-10', 'topic-42'];
const urlId: string = 'url_5d7a1e';
const startDate: Date = new Date('2025-09-01T08:00:00Z');
const forceRecalculate: boolean = true;
const minValue: number = 1;
const maxValue: number = 5;
const limit: number = 50;
const result: CombineCommentsWithQuestionResults200Response = await combineCommentsWithQuestionResults(
  tenantId,
  undefined,
  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-corp-tenant-42";
const createUser: CreateAPISSOUserData = {
  id: "u-7f3b9",
  email: "jane.doe@acme-corp.com",
  username: "jane.doe",
  displayName: "Jane Doe",         // optional
  roles: ["moderator"],            // optional
  metadata: { department: "Marketing" } // optional
};
const result: AddSSOUserAPIResponse = await addSSOUser(tenantId, createUser);

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 = "fc_tenant_8f3b2a9c";
const id: string = "sso_user_5c9d2b";
const deleteComments: boolean = true;
const commentDeleteMode: string = "anonymize";
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

type FetchOptions = { includeDeactivated?: boolean };
const tenantId: string = "acme-tenant-84";
const email: string = "jane.doe@acme.com";
const options: FetchOptions = { includeDeactivated: true };
const result: GetSSOUserByEmailAPIResponse = await getSSOUserByEmail(tenantId, email);
const ssoUser: APISSOUser | undefined = (result as unknown as { user?: APISSOUser })?.user

getSSOUserById

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

Response

Returns: GetSSOUserByIdAPIResponse

Example

getSSOUserById Example

Copy

const tenantId: string = 'tenant_9a1b2c_org_4f3b2a';
const userId: string = 'sso_user_8c7d6e5f';
const response: GetSSOUserByIdAPIResponse = await getSSOUserById(tenantId, userId);
const ssoUser: APISSOUser | undefined = (response as unknown as { user?: APISSOUser }).user;
const email: string | undefined = ssoUser?.email;

getSSOUsers

Parameters

Name	Type	Required	Description
tenantId	string	Yes
skip	number	No

Response

Returns: GetSSOUsers200Response

Example

getSSOUsers Example

Copy

(async () => {
  const tenantId: string = 'tenant_8a3c4b2e';
  const ssoResultDefault: GetSSOUsers200Response = await getSSOUsers(tenantId);
  const ssoResultPaged: GetSSOUsers200Response = await getSSOUsers(tenantId, 50);
  console.log(ssoResultDefault, ssoResultPaged);
})();

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_acme_987";
const id: string = "ssouser_0042";
const updateAPISSOUserData: UpdateAPISSOUserData = {
  email: "jane.doe@acmecorp.com",
  displayName: "Jane Doe",
  externalId: "okta|00u1abcd2345EFGHIJ6",
  roles: ["moderator"],
  active: true,
  metadata: { team: "Customer Success", location: "NYC" },
};
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-tenant-01'
const id: string = 'user_987654321'
const updateAPISSOUserData: UpdateAPISSOUserData = {
  email: 'jane.doe@acme.com',
  displayName: 'Jane Doe',
  roles: ['editor'],
  externalId: 'sso|12345',
  avatarUrl: 'https://cdn.acme.com/avatars/jane.jpg',
  isActive: true,
  metadata: { department: 'Product' }
}
const updateComments: boolean = true
const result: PutSSOUserAPIResponse = await putSSOUser(tenantId, id, updateAPISSOUserData, updateComments)
console.log(result)

createSubscription

Parameters

Name	Type	Required	Description
tenantId	string	Yes
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	Yes

Response

Returns: CreateSubscriptionAPIResponse

Example

createSubscription Example

Copy

const tenantId: string = "fc_tenant_9b2c4f";
const createAPIUserSubscriptionData: CreateAPIUserSubscriptionData = {
  userId: "user_72a1",
  email: "jane.doe@acme-corp.com",
  planId: "pro_annual",
  paymentMethod: { type: "card", brand: "Visa", last4: "4242" },
  autoRenew: true,
  trialEndsAt: "2026-01-15T00:00:00Z", // optional parameter
  metadata: { company: "Acme Corp", role: "editor" } // optional
};
const response: CreateSubscriptionAPIResponse = await createSubscription(tenantId, createAPIUserSubscriptionData);

deleteSubscription

Parameters

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

Response

Returns: DeleteSubscriptionAPIResponse

Example

deleteSubscription Example

Copy

(async () => {
  const tenantId: string = 'tenant_acme_news_01';
  const subscriptionId: string = 'sub_5f3b9a1c';
  const response1: DeleteSubscriptionAPIResponse = await deleteSubscription(tenantId, subscriptionId);
  const userId: string = 'user_4b9d2e';
  const response2: DeleteSubscriptionAPIResponse = await deleteSubscription(tenantId, subscriptionId, userId);
  console.log(response1, response2);
})();

getSubscriptions

Parameters

Name	Type	Required	Description
tenantId	string	Yes
userId	string	No

Response

Returns: GetSubscriptionsAPIResponse

Example

getSubscriptions Example

Copy

const tenantId: string = "acme-tenant-001";
const subscriptions: GetSubscriptionsAPIResponse = await getSubscriptions(tenantId);
const userId: string = "user_jane.doe@acme.com";
const userSubscriptions: GetSubscriptionsAPIResponse = await getSubscriptions(tenantId, userId);

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 = 'fc-tenant-9a8b7c';
const pngData: Uint8Array = new Uint8Array([137, 80, 78, 71, 13, 10, 26, 10]);
const file: Blob = new Blob([pngData], { type: 'image/png' });
const sizePreset: SizePreset = { width: 800, height: 800, fit: 'cover' };
const urlId: string = 'profiles/8f3d1a-avatar';
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-media-592";
const suffix: string | undefined = "mobile"; // optional parameter that may modify which user id to request
const id: string = suffix ? `user_9f8b2a-${suffix}` : "user_9f8b2a";
const result: GetUserBadgeProgressById200Response = await getUserBadgeProgressById(tenantId, id);
console.log(result);

getUserBadgeProgressByUserId

Parameters

Name	Type	Required	Description
tenantId	string	Yes
userId	string	Yes

Response

Returns: GetUserBadgeProgressById200Response

Example

getUserBadgeProgressByUserId Example

Copy

const tenantId: string = 'tenant_58a1c3';
const userId: string = 'user_b2f4e9a7';
const progress: GetUserBadgeProgressById200Response = await getUserBadgeProgressByUserId(tenantId, userId);

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_acme_2025";
const userId: string = "user_00123";
const limit: number = 25;
const skip: number = 0;
const badgeProgress: GetUserBadgeProgressList200Response = await getUserBadgeProgressList(tenantId, userId, limit, skip);
const badgeProgressAll: GetUserBadgeProgressList200Response = await getUserBadgeProgressList(tenantId);

createUserBadge

Parameters

Name	Type	Required	Description
tenantId	string	Yes
createUserBadgeParams	CreateUserBadgeParams	Yes

Response

Returns: CreateUserBadge200Response

Example

createUserBadge Example

Copy

const tenantId: string = "tenant_82b9e3";
const createUserBadgeParams: CreateUserBadgeParams = {
  key: "expert-contributor",
  title: "Expert Contributor",
  description: "Awarded for consistently helpful technical answers",
  imageUrl: "https://cdn.fastcomments.example/badges/expert.png",
  isPublic: true,
  tier: 2,
  // optional parameters
  metadata: { awardedBy: "moderation-team", createdAt: "2025-10-30T12:00:00Z" },
  expiresAt: "2026-10-30T12:00:00Z"
};
const createdBadge: CreateUserBadge200Response = await createUserBadge(tenantId, createUserBadgeParams);

deleteUserBadge

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

Response

Returns: UpdateUserBadge200Response

Example

deleteUserBadge Example

Copy

const tenantId: string = 'tenant_9f1b2c34';
const id: string = 'badge_7a3d2f59';
type DeleteOptions = { notifySubscribers?: boolean }; // optional parameter shape
const options: DeleteOptions = { notifySubscribers: true };
const result: UpdateUserBadge200Response = await deleteUserBadge(tenantId, id);

getUserBadge

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

Response

Returns: GetUserBadge200Response

Example

getUserBadge Example

Copy

const tenantIdOptional: string | undefined = process.env.TENANT_ID;
const tenantId: string = tenantIdOptional ?? 'tenant_acme_corp_42';
const badgeId: string = 'badge_7f3a9d2';
const response: GetUserBadge200Response = await getUserBadge(tenantId, badgeId);
console.log(response);

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

const tenantId: string = "tenant_acme_site_01";
const userId: string = "user_7b9f3d";
const badgeId: string = "badge_top_contributor";
const type: number = 2;
const displayedOnComments: boolean = true;
const limit: number = 20;
const skip: number = 0;
const response: GetUserBadges200Response = await getUserBadges(tenantId, userId, badgeId, type, displayedOnComments, limit, skip);

updateUserBadge

Parameters

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

Response

Returns: UpdateUserBadge200Response

Example

updateUserBadge Example

Copy

const tenantId: string = "tenant_9f3b2c";
const id: string = "badge_42a1";
const updateUserBadgeParams: UpdateUserBadgeParams = {
  name: "Top Contributor",
  description: "Awarded for 1,000 helpful posts across the community",
  level: 4,
  iconUrl: "https://cdn.fastcomments.com/badges/top-contributor.png",
  isActive: true,
  notifyUser: true, // optional flag
  expiresAt: "2027-01-01T00:00:00Z" // optional expiry
};
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 = 'tenant_84b7c2';
const ssoToken: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjoiamRvZSIsImlhdCI6MTY5MDAwMDB9.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
const notificationCountWithoutSSO: GetUserNotificationCount200Response = await getUserNotificationCount(tenantId);
const notificationCountWithSSO: 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 tenantId: string = 'tenant-12345';
const pageSize: number = 25;
const includeContext: boolean = true;
const afterCreatedAt: number = Date.now() - 24 * 60 * 60 * 1000;
const unreadOnly: boolean = true;
const includeTranslations: boolean = false;
const sso: string = 'sso-eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
const notifications: GetUserNotifications200Response = await getUserNotifications(
  tenantId,
  pageSize,
  undefined,
  includeContext,
  afterCreatedAt,
  unreadOnly,
  undefined,
  undefined,
  includeTranslations,
  sso
);

resetUserNotificationCount

Parameters

Name	Type	Required	Description
tenantId	string	Yes
sso	string	No

Response

Returns: ResetUserNotifications200Response

Example

resetUserNotificationCount Example

Copy

(async () => {
  const tenantId: string = 'acme-corp-78';
  const ssoToken: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.fakeSignature';
  const responseWithSso: ResetUserNotifications200Response = await resetUserNotificationCount(tenantId, ssoToken);
  const responseWithoutSso: ResetUserNotifications200Response = await resetUserNotificationCount(tenantId);
  console.log(responseWithSso, responseWithoutSso);
})();

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 tenantId: string = 'tenant_12345';
const afterId: string = 'notif_98765';
const afterCreatedAt: number = Date.now() - 1000 * 60 * 60 * 24;
const unreadOnly: boolean = true;
const dmOnly: boolean = false;
const noDm: boolean = false;
const sso: string = 'sso_jwt_token_eyJhbGciOiJIUzI1Ni';
const result: ResetUserNotifications200Response = await resetUserNotifications(tenantId, afterId, afterCreatedAt, unreadOnly, dmOnly, noDm, sso);

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

(async () => {
  const tenantId: string = 'tenant_84f3a2';
  const notificationId: string = 'notif_7b9c2f';
  const optedInOrOut: UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum = 'opted_in' as UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum;
  const commentId: string = 'comment_582b3';
  const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature';
  const result: UpdateUserNotificationStatus200Response = await updateUserNotificationCommentSubscriptionStatus(tenantId, notificationId, optedInOrOut, commentId, sso);
  console.log(result);
})();

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

(async () => {
  const tenantId: string = 'tenant_acme_01';
  const urlId: string = 'post-2025-11-04-8742';
  const url: string = 'https://acme.example.com/posts/ai-update';
  const pageTitle: string = 'AI Update — November 2025';
  const subscribedOrUnsubscribed: UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum = UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum.SUBSCRIBED;
  const ssoToken: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.payload';
  const resultWithSso: UpdateUserNotificationStatus200Response = await updateUserNotificationPageSubscriptionStatus(tenantId, urlId, url, pageTitle, subscribedOrUnsubscribed, ssoToken);
  const resultWithoutSso: UpdateUserNotificationStatus200Response = await updateUserNotificationPageSubscriptionStatus(tenantId, urlId, url, pageTitle, UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum.UNSUBSCRIBED);
  console.log(resultWithSso, resultWithoutSso);
})();

updateUserNotificationStatus

Parameters

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

Response

Returns: UpdateUserNotificationStatus200Response

Example

updateUserNotificationStatus Example

Copy

(async () => {
  const tenantId: string = 'tenant_acme_01';
  const notificationId: string = 'notif_2025-11-04-7890';
  const ssoToken: string | undefined = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
  const result: UpdateUserNotificationStatus200Response = await updateUserNotificationStatus(
    tenantId,
    notificationId,
    UpdateUserNotificationStatusNewStatusEnum.READ,
    ssoToken
  );
  console.log(result);
})();

getUserPresenceStatuses

Parameters

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

Response

Returns: GetUserPresenceStatuses200Response

Example

getUserPresenceStatuses Example

Copy

const tenantId: string = 'tenant_7d9a3b';
const urlIdWS: string | undefined = 'ws-4b8f2'; // optional at runtime
const userIds: string = 'user_1024,user_2048';
const result: GetUserPresenceStatuses200Response = await getUserPresenceStatuses(tenantId, urlIdWS ?? 'ws-4b8f2', userIds);

searchUsers

Parameters

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

Response

Returns: SearchUsers200Response

Example

searchUsers Example

Copy

const tenantId: string = 'tenant_9a8b7c';
const urlId: string = 'article-67890-latest-news';
const usernameStartsWith: string = 'alex';
const mentionGroupIds: Array<string> = ['editors', 'community-moderators'];
const sso: string = 'sso-jwt-abc123def456';
const usersResponse: SearchUsers200Response = await searchUsers(tenantId, urlId, usernameStartsWith, mentionGroupIds, sso);

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.

Getting Started

API Reference

Documentation

Usage

Aggregate

Audit Logs

Block From Comment

Check Blocked Comments

Comments

Domain Configs

Event Log

Feed Posts

Flag Comment

Pages

Question Results Aggregation

SSO Users

Subscriptions

Upload Image

User Badge Progress

User Badges

User Notifications

User Presence Status

User Search

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

TypeScript Support

aggregate

Parameters

Response

Example

getAuditLogs

Parameters

Response

Example

blockFromCommentPublic

Parameters

Response

Example

unBlockCommentPublic

Parameters

Response

Example

checkedCommentsForBlocked

Parameters

Response

Example

blockUserFromComment

Parameters

Response

Example

createCommentPublic