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 || [];

bulkAggregateQuestionResults

POST /api/v1/question-results-aggregation/bulk

Parameters

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

Response

Returns: BulkAggregateQuestionResults200Response

Example

bulkAggregateQuestionResults Example

Copy

const tenantId: string = 'tenant_83a2b';
const bulkAggregateQuestionResultsRequest: BulkAggregateQuestionResultsRequest = {
  aggregations: [
    { aggId: 'agg-001', questionId: 'q-9876', timeBucket: 'day', startDate: new Date('2025-01-01T00:00:00Z') },
    { aggId: 'agg-002', questionIds: ['q-123', 'q-456'], urlId: 'article-789', timeBucket: 'month', startDate: new Date('2024-06-01T00:00:00Z') }
  ]
};
const forceRecalculate: boolean = true;
const result: BulkAggregateQuestionResults200Response = await bulkAggregateQuestionResults(tenantId, bulkAggregateQuestionResultsRequest, forceRecalculate);

createFeedPost

POST /api/v1/feed-posts

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_12345";
const createFeedPostParams: CreateFeedPostParams = {
  title: "Weekly Product Update — October",
  contentHTML: "<p>We shipped a faster search index and fixed login issues for iOS users.</p>",
  media: [{ title: "Release Screenshot", linkUrl: "https://cdn.example.com/screenshot.png", sizes: [{ w: 1200, h: 800, src: "https://cdn.example.com/screenshot_1200.png" }] }],
  links: [{ text: "Changelog", title: "Full changelog", url: "https://app.example.com/changelog/october" }],
  fromUserId: "user_782",
  fromUserDisplayName: "Product Team",
  tags: ["release", "product", "ios"],
  key: "release-oct-2025",
  meta: { source: "web-dashboard", environment: "production" }
};
const broadcastId: string = "broadcast_98765";
const isLive: boolean = true;
const doSpamCheck: boolean = true;
const skipDupCheck: boolean = false;
const result: CreateFeedPost200Response = await createFeedPost(tenantId, createFeedPostParams, broadcastId, isLive, doSpamCheck, skipDupCheck);

blockUserFromComment

POST /api/v1/comments/{id}/block

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_acme_001';
const id: string = 'comment_4321';
const blockFromCommentParams: BlockFromCommentParams = { commentIdsToCheck: ['comment_4320', 'comment_4319'] };
const userId: string = 'user_8842';
const anonUserId: string = 'anon_7f9b';
const result: BlockFromCommentPublic200Response = await blockUserFromComment(tenantId, id, blockFromCommentParams, userId, anonUserId);

createSubscription

POST /api/v1/subscriptions

Parameters

Name	Type	Required	Description
tenantId	string	Yes
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	Yes

Response

Returns: CreateSubscriptionAPIResponse

Example

createSubscription Example

Copy

const tenantId: string = 'acme-tenant-01';
const createAPIUserSubscriptionData: CreateAPIUserSubscriptionData = {
  urlId: 'blog-fastcomments-launch-2025',
  pageTitle: 'FastComments Launch: What’s New in 2025',
  url: 'https://blog.acme.com/fastcomments-launch-2025',
  anonUserId: 'anon_84b7',
  userId: 'user_92a1'
};
const response: CreateSubscriptionAPIResponse = await createSubscription(tenantId, createAPIUserSubscriptionData);
console.log(response.subscription?.id, response.status);

aggregateQuestionResults

GET /api/v1/question-results-aggregation

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_acme_01';
const questionId: string | undefined = undefined;
const questionIds: Array<string> = ['q-4572', 'q-4573'];
const urlId: string = 'articles/homepage';
const timeBucket: AggregateTimeBucket = 'month';
const startDate: Date = new Date('2025-01-01T00:00:00Z');
const forceRecalculate: boolean = true;
const result: AggregateQuestionResults200Response = await aggregateQuestionResults(
  tenantId,
  questionId,
  questionIds,
  urlId,
  timeBucket,
  startDate,
  forceRecalculate
);

addSSOUser

POST /api/v1/sso-users

Parameters

Name	Type	Required	Description
tenantId	string	Yes
createAPISSOUserData	CreateAPISSOUserData	Yes

Response

Returns: AddSSOUserAPIResponse

Example

addSSOUser Example

Copy

const tenantId: string = 'tenant_7f3b2a';
const createAPISSOUserData: CreateAPISSOUserData = {
  groupIds: ['grp_4a1b2c'],
  hasBlockedUsers: false,
  isProfileCommentsPrivate: false,
  isCommentModeratorAdmin: true,
  isAdminAdmin: false,
  isAccountOwner: false,
  displayName: 'Jane Doe',
  displayLabel: 'Jane D.',
  optedInSubscriptionNotifications: true,
  optedInNotifications: true,
  avatarSrc: 'https://cdn.acmecorp.com/avatars/jane.doe.jpg',
  loginCount: 12,
  createdFromUrlId: 'homepage_banner',
  signUpDate: 1698770000000,
  email: 'jane.doe@acmecorp.com',
  websiteUrl: 'https://jane.acme.dev',
  username: 'jane.doe',
  id: 'user_9c4b1a'
};
const result: AddSSOUserAPIResponse = await addSSOUser(tenantId, createAPISSOUserData);

addPage

POST /api/v1/pages

Parameters

Name	Type	Required	Description
tenantId	string	Yes
createAPIPageData	CreateAPIPageData	Yes

Response

Returns: AddPageAPIResponse

Example

addPage Example

Copy

const tenantId: string = 'acme-corp_tenant_78';
const createData: CreateAPIPageData = { accessibleByGroupIds: ['engineering-team', 'marketing-team'], rootCommentCount: 0, title: 'Acme Product Launch — June 2025', url: 'https://blog.acme-corp.com/posts/product-launch-june-2025', urlId: 'acme-product-launch-2025' };
const result: AddPageAPIResponse = await addPage(tenantId, createData);

aggregate

POST /api/v1/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 = 'tenant_42';
const parentTenantId: string = 'org_7';
const includeStats: boolean = true;
const aggregationRequest: AggregationRequest = {
  resourceName: 'article:12345',
  query: [
    { key: 'createdAt', value: { from: '2025-01-01T00:00:00Z' }, operator: 'gte' },
    { key: 'status', value: 'published', operator: 'eq' }
  ],
  groupBy: ['authorId'],
  operations: [
    { field: 'id', op: 'count', alias: 'commentCount' },
    { field: 'userId', op: 'countDistinct', alias: 'uniqueCommenters' }
  ],
  sort: { field: 'commentCount', dir: 'desc' }
};
const result: AggregationResponse = await aggregate(tenantId, aggregationRequest, parentTenantId, includeStats);

combineCommentsWithQuestionResults

GET /api/v1/question-results-aggregation/combine/comments

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_5d2c9a4b';
const questionIds: Array<string> = ['q-1001', 'q-1002'];
const startDate: Date = new Date('2025-06-01T00:00:00Z');
const forceRecalculate: boolean = true;
const limit: number = 100;
const result: CombineCommentsWithQuestionResults200Response = await combineCommentsWithQuestionResults(
  tenantId,
  undefined, // questionId (optional)
  questionIds,
  undefined, // urlId (optional)
  startDate,
  forceRecalculate,
  0,    // minValue (optional)
  100,  // maxValue (optional)
  limit // limit (optional)
);

addDomainConfig

POST /api/v1/domain-configs

Parameters

Name	Type	Required	Description
tenantId	string	Yes
addDomainConfigParams	AddDomainConfigParams	Yes

Response

Returns: AddDomainConfig200Response

Example

addDomainConfig Example

Copy

type AddDomainConfigParams = {
  domain: string;
  emailFromName?: string;
  emailFromEmail?: string;
  logoSrc?: string;
  logoSrc100px?: string;
  footerUnsubscribeURL?: string;
  [key: string]: any;
  emailHeaders?: { [key: string]: string };
};
type AddDomainConfig200Response = {
  reason: string;
  code: string;
  status: any | null;
  _configuration: any | null;
};
const tenantId: string = "tenant_prod_9b2c4a";
const params: AddDomainConfigParams = {
  domain: "comments.acme-corp.com",
  emailFromName: "Acme Notifications",
  emailFromEmail: "notifications@acme-corp.com",
  logoSrc: "https://assets.acme-corp.com/logo-wide.png",
  logoSrc100px: "https://assets.acme-corp.com/logo-100.png",
  footerUnsubscribeURL: "https://acme-corp.com/account/unsubscribe",
  emailHeaders: { "X-Acme-Env": "production", "Reply-To": "support@acme-corp.com" },
  key: "acme_comments_domain_key_v1"
};
const result: AddDomainConfig200Response = await addDomainConfig(tenantId, params);

createUserBadge

POST /api/v1/user-badges

Parameters

Name	Type	Required	Description
tenantId	string	Yes
createUserBadgeParams	CreateUserBadgeParams	Yes

Response

Returns: CreateUserBadge200Response

Example

createUserBadge Example

Copy

const tenantId: string = 'tenant_6a8f3b2c';
const createUserBadgeParams: CreateUserBadgeParams = { userId: 'user_1942', badgeId: 'top_contributor', displayedOnComments: true };
const response: CreateUserBadge200Response = await createUserBadge(tenantId, createUserBadgeParams);

deleteComment

DELETE /api/v1/comments/{id}

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 = 'fastcomments_tenant_42';
const id: string = 'cmt_7f3b2a1c';
const contextUserId: string = 'moderator_1024';
const isLive: boolean = false;
const result: DeleteComment200Response = await deleteComment(tenantId, id, contextUserId, isLive);

deletePage

DELETE /api/v1/pages/{id}

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

Response

Returns: DeletePageAPIResponse

Example

deletePage Example

Copy

const tenantId: string = 'tenant_81b4c7e9';
const pageId: string = 'page_5f3a2b1c';
const result: DeletePageAPIResponse = await deletePage(tenantId, pageId);
const reason: string | undefined = result.reason;
const code: string | undefined = result.code;
const status: string = result.status;

deleteSSOUser

DELETE /api/v1/sso-users/{id}

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 = 'tenant_6f2b1c9d';
const userId: string = '5f3d2a9c-4b1e-47a2-9f0c-2e8d3b7c9f6a';
const deleteComments: boolean = true;
const commentDeleteMode: string = 'anonymize';
const result: DeleteSSOUserAPIResponse = await deleteSSOUser(tenantId, userId, deleteComments, commentDeleteMode);

deleteUserBadge

DELETE /api/v1/user-badges/{id}

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

Response

Returns: UpdateUserBadge200Response

Example

deleteUserBadge Example

Copy

const result: UpdateUserBadge200Response = await deleteUserBadge('tenant_acme_corp', 'badge_987654321');
const status: 'failed' = result.status;
const secondaryCode: string | undefined = result.secondaryCode;
const bannedUntil: number | undefined = result.bannedUntil;
const maxCommentLength: number | null | undefined = result.customConfig?.maxCommentCharacterLength;

flagComment

POST /api/v1/comments/{id}/flag

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 = 'site_82b9f4';
const commentId: string = 'cmt_a3f1d9e7';
const userId: string = 'user_9842'; // optional parameter provided
const response: FlagComment200Response = await flagComment(tenantId, commentId, userId);

deleteDomainConfig

DELETE /api/v1/domain-configs/{domain}

Parameters

Name	Type	Required	Description
tenantId	string	Yes
domain	string	Yes

Response

Returns: DeleteDomainConfig200Response

Example

deleteDomainConfig Example

Copy

type DeleteDomainConfig200Response = { status: any | null };
const tenantId: string = process.env.FASTCOMMENTS_TENANT_ID ?? 'acme-corp-tenant-8421';
const domain: string = 'comments.acmeproducts.com';
const domainAlias: string | undefined = process.env.DELETE_DOMAIN_ALIAS;
const result: DeleteDomainConfig200Response = await deleteDomainConfig(tenantId, domainAlias ?? domain);

getComment

GET /api/v1/comments/{id}

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

Response

Returns: GetComment200Response

Example

getComment Example

Copy

async function example(): Promise<void> {
  const tenantId: string = 'tenant_9a2b3c';
  const commentId: string = 'cmt-7f6e5d4c';
  const result: GetComment200Response = await getComment(tenantId, commentId);
  const bannedUntil: number | undefined = result.bannedUntil;
  const translatedError: string | undefined = result.translatedError;
  const pageTitle: string | undefined = result.comment.pageTitle;
  console.log(result.status, result.comment.id, pageTitle, bannedUntil, translatedError);
}
example();

getAuditLogs

GET /api/v1/audit-logs

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_827f2b1a';
const limit: number = 100;
const order: SORTDIR = 'DESC';
const after: number = Date.now() - 30 * 24 * 60 * 60 * 1000;
const response: GetAuditLogs200Response = await getAuditLogs(tenantId, limit, undefined, order, after);

getDomainConfig

GET /api/v1/domain-configs/{domain}

Parameters

Name	Type	Required	Description
tenantId	string	Yes
domain	string	Yes

Response

Returns: GetDomainConfig200Response

Example

getDomainConfig Example

Copy

const tenantId: string = "acme-corp-01";
const preferredDomain: string | undefined = "comments.acme.com";
const domain: string = preferredDomain ?? "acme-corp.com";
const response: GetDomainConfig200Response = await getDomainConfig(tenantId, domain);

deleteSubscription

DELETE /api/v1/subscriptions/{id}

Parameters

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

Response

Returns: DeleteSubscriptionAPIResponse

Example

deleteSubscription Example

Copy

(async () => {
  const tenantId: string = 'fc-tenant-001';
  const subscriptionId: string = '34d9e7b2-8c41-4f6a-a2d3-9f0b6c5e21a7';
  const userId: string = 'user-8723';
  const resultWithUser: DeleteSubscriptionAPIResponse = await deleteSubscription(tenantId, subscriptionId, userId);
  const resultWithoutUser: DeleteSubscriptionAPIResponse = await deleteSubscription(tenantId, subscriptionId);
  console.log(resultWithUser, resultWithoutUser);
})();

getFeedPosts

GET /api/v1/feed-posts

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_83b2f';
const afterId: string = 'post_20251101_a7';
const limit: number = 25;
const tags: Array<string> = ['news', 'product-launch'];
const feedResponse: GetFeedPosts200Response = await getFeedPosts(tenantId, afterId, limit, tags);

getPages

GET /api/v1/pages

Parameters

Name	Type	Required	Description
tenantId	string	Yes

Response

Returns: GetPagesAPIResponse

Example

getPages Example

Copy

const tenantId: string = 'tenant_acme_98765';
const result: GetPagesAPIResponse = await getPages(tenantId);
const firstPage: APIPage | undefined = result.pages?.[0];
const pageUrl: string | undefined = firstPage?.url;
const isClosed: boolean | undefined = firstPage?.isClosed;
console.log(result.status, firstPage?.title, pageUrl, isClosed);

getComments

GET /api/v1/comments

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 response: GetComments200Response = await getComments(
  "news-site-123",
  1,
  25,
  undefined,
  true,
  undefined,
  undefined,
  3,
  "article-2025-11-03-poll",
  "user_9876",
  undefined,
  undefined,
  "election",
  "cmt_a1b2c3",
  "MR"
);

getDomainConfigs

GET /api/v1/domain-configs

Parameters

Name	Type	Required	Description
tenantId	string	Yes

Response

Returns: GetDomainConfigs200Response

Example

getDomainConfigs Example

Copy

const tenantId: string = 'acme-website-001';
const includeArchived: boolean | undefined = undefined; // optional flag (not required by function)
const result: GetDomainConfigs200Response = await getDomainConfigs(tenantId);
const primaryReason: string = result.reason;
const firstConfiguration: any | null = (result.configurations as any[] | null)?.[0] ?? null;

getUserBadge

GET /api/v1/user-badges/{id}

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

Response

Returns: GetUserBadge200Response

Example

getUserBadge Example

Copy

const tenantId: string = 'acme-tenant-01';
const badgeId: string = 'badge_7a9c2f';
const response: GetUserBadge200Response = await getUserBadge(tenantId, badgeId);
const secondaryCode: string | undefined = response.secondaryCode;
const bannedUntil: number | undefined = response.bannedUntil;
const maxCommentLen: number | null | undefined = response.customConfig?.maxCommentCharacterLength;

getSSOUsers

GET /api/v1/sso-users

Parameters

Name	Type	Required	Description
tenantId	string	Yes
skip	number	No

Response

Returns: GetSSOUsers200Response

Example

getSSOUsers Example

Copy

(async () => {
  const tenantId: string = "site_3f9d2b7a";
  const skip: number = 50;
  const responseWithSkip: GetSSOUsers200Response = await getSSOUsers(tenantId, skip);
  const responseNoSkip: GetSSOUsers200Response = await getSSOUsers(tenantId);
  console.log(responseWithSkip.users.length, responseNoSkip.status);
})();

getPageByURLId

GET /api/v1/pages/by-url-id

Parameters

Name	Type	Required	Description
tenantId	string	Yes
urlId	string	Yes

Response

Returns: GetPageByURLIdAPIResponse

Example

getPageByURLId Example

Copy

const tenantId: string = 'newsroom-prod-01';
const urlId: string = 'article-7d3f2a9b';
const result: GetPageByURLIdAPIResponse = await getPageByURLId(tenantId, urlId);
const isClosed: boolean | undefined = result.page?.isClosed;
const pageUrl: string | undefined = result.page?.url;
const groupIds: string[] = result.page?.accessibleByGroupIds ?? [];
const rootComments: number = result.page?.rootCommentCount ?? 0;

getUserBadgeProgressById

GET /api/v1/user-badge-progress/{id}

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

Response

Returns: GetUserBadgeProgressById200Response

Example

getUserBadgeProgressById Example

Copy

const tenantId: string = 'tenant_98765';
const badgeProgressId: string = '3b9f1e2a-8c4d-4a7e-b0f1-2c3d4e5f6a7b';
const result: GetUserBadgeProgressById200Response = await getUserBadgeProgressById(tenantId, badgeProgressId);
const progress: UserBadgeProgress = result.userBadgeProgress;
const autoTrustFactor: number | undefined = progress.autoTrustFactor;
const secondaryCode: string | undefined = result.secondaryCode;
const bannedUntil: number | undefined = result.bannedUntil;

getSSOUserByEmail

GET /api/v1/sso-users/by-email/{email}

Parameters

Name	Type	Required	Description
tenantId	string	Yes
email	string	Yes

Response

Returns: GetSSOUserByEmailAPIResponse

Example

getSSOUserByEmail Example

Copy

(async () => {
  const tenantId: string = 'tenant_4f9e7b';
  const email: string = 'jane.doe@acme-corp.com';
  const response: GetSSOUserByEmailAPIResponse = await getSSOUserByEmail(tenantId, email);
  const user: APISSOUser | undefined = response.user;
  const isAccountOwner: boolean | undefined = user?.isAccountOwner;
  console.log(response.status, user?.id, isAccountOwner);
})();

getUserBadgeProgressList

GET /api/v1/user-badge-progress

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_news';
const userId: string = 'user_9f8d7c';
const limit: number = 25;
const response: GetUserBadgeProgressList200Response = await getUserBadgeProgressList(tenantId, userId, limit);

getUserBadgeProgressByUserId

GET /api/v1/user-badge-progress/user/{userId}

Parameters

Name	Type	Required	Description
tenantId	string	Yes
userId	string	Yes

Response

Returns: GetUserBadgeProgressById200Response

Example

getUserBadgeProgressByUserId Example

Copy

const tenantId: string = 'tenant_88f3b9';
const userId: string = 'user_4a7c2f';
const progressResponse: GetUserBadgeProgressById200Response = await getUserBadgeProgressByUserId(tenantId, userId);
const secondaryCode: string | undefined = progressResponse.secondaryCode;
const maxCommentLength: number | undefined = progressResponse.customConfig?.maxCommentCharacterLength ?? undefined;
const firstCommentBadgeProgress: number | undefined = progressResponse.userBadgeProgress.progress['first_comment'];

getUserBadges

GET /api/v1/user-badges

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_corp_01';
const userId: string = 'user_71b2a9';
const badgeId: string = 'gold_contributor';
const displayedOnComments: boolean = true;
const limit: number = 10;
const skip: number = 0;
const result: GetUserBadges200Response = await getUserBadges(
  tenantId,
  userId,
  badgeId,
  undefined, // type omitted
  displayedOnComments,
  limit,
  skip
);

getSSOUserById

GET /api/v1/sso-users/by-id/{id}

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

Response

Returns: GetSSOUserByIdAPIResponse

Example

getSSOUserById Example

Copy

const tenantId: string = 'tenant_3f9a7c';
const id: string = '9b1deb4d-5f3a-4c6a-8f2e-7d9a1c2b3e4f';
const response: GetSSOUserByIdAPIResponse = await getSSOUserById(tenantId, id);
const user: APISSOUser | undefined = response.user;
const groupCount: number = user?.groupIds?.length ?? 0;
console.log(`status=${response.status} code=${response.code ?? 'none'} user=${user?.displayName ?? user?.username ?? 'n/a'} groups=${groupCount} owner=${user?.isAccountOwner ? 'yes' : 'no'}`);

patchDomainConfig

PATCH /api/v1/domain-configs/{domainToUpdate}

Parameters

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

Response

Returns: GetDomainConfig200Response

Example

patchDomainConfig Example

Copy

const tenantId: string = "tenant_9a3c2f";
const domainToUpdate: string = "comments.example.com";
const patchDomainConfigParams: PatchDomainConfigParams = {
  emailFromName: "Example Comments Team",
  emailFromEmail: "no-reply@notifications.example.com",
  logoSrc100px: "https://cdn.example.com/assets/logo-100.png",
  emailHeaders: {
    "Reply-To": "support@example.com",
    "List-Unsubscribe": "<mailto:unsubscribe@example.com>"
  },
  supportPhone: "+1-800-555-0123"
};
const result: GetDomainConfig200Response = await patchDomainConfig(tenantId, domainToUpdate, patchDomainConfigParams);

getSubscriptions

GET /api/v1/subscriptions

Parameters

Name	Type	Required	Description
tenantId	string	Yes
userId	string	No

Response

Returns: GetSubscriptionsAPIResponse

Example

getSubscriptions Example

Copy

(async () => {
  const subscriptionsWithUser: GetSubscriptionsAPIResponse = await getSubscriptions('tenant_9f8b1c', 'user_4a7e22');
  const subscriptionsWithoutUser: GetSubscriptionsAPIResponse = await getSubscriptions('tenant_9f8b1c');
  console.log(subscriptionsWithUser, subscriptionsWithoutUser);
})();

patchPage

PATCH /api/v1/pages/{id}

Parameters

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

Response

Returns: PatchPageAPIResponse

Example

patchPage Example

Copy

const tenantId: string = 'acme-tenant-42';
const id: string = 'page_9b7c';
const updateAPIPageData: UpdateAPIPageData = {
  isClosed: true,
  accessibleByGroupIds: ['group-moderators', 'group-paid-subscribers'],
  urlId: 'install-widget-3' // optional parameter used here; title and url omitted
};
const response: PatchPageAPIResponse = await patchPage(tenantId, id, updateAPIPageData);
console.log(response.status, response.page?.title, response.page?.createdAt);

saveComment

POST /api/v1/comments

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-123';
const createCommentParams: CreateCommentParams = {
  commenterName: 'Alex Morgan',
  commenterEmail: 'alex.morgan@example.com',
  comment: 'Great write-up — this clarified several deployment pitfalls for me.',
  url: 'https://www.example.com/blog/deploying-typescript',
  urlId: 'deploying-typescript-2025',
  pageTitle: 'Deploying TypeScript Services',
  locale: 'en_us',
  rating: 5,
  key: 'submission-abc123'
};
const isLive: boolean = true;
const doSpamCheck: boolean = true;
const sendEmails: boolean = false;
const populateNotifications: boolean = true;
const result: SaveComment200Response = await saveComment(tenantId, createCommentParams, isLive, doSpamCheck, sendEmails, populateNotifications);

patchSSOUser

PATCH /api/v1/sso-users/{id}

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_8b7f3c9a";
const id: string = "user_92a1f4b7";
const updateData: UpdateAPISSOUserData = {
  displayName: "Jordan Lee",
  displayLabel: "Jordan L.",
  email: "jordan.lee@example.com",
  avatarSrc: "https://cdn.example.net/avatars/jordan.jpg",
  optedInNotifications: true,
  optedInSubscriptionNotifications: false,
  websiteUrl: "https://jordan.dev",
  username: "jordanlee",
  loginCount: 42,
  signUpDate: 1627849200000,
  groupIds: ["moderators", "beta_testers"],
  isCommentModeratorAdmin: true
};
const result: PatchSSOUserAPIResponse = await patchSSOUser(tenantId, id, updateData, true);

saveCommentsBulk

POST /api/v1/comments/bulk

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_7f3a2b";
const createCommentParams: CreateCommentParams[] = [{
  date: Date.now(),
  localDateString: new Date().toLocaleString(),
  commenterName: "Jordan Smith",
  commenterEmail: "jordan.smith@example.com",
  comment: "This feature fixed a workflow bottleneck for our team — great job!",
  productId: 402,
  userId: "usr_1029",
  avatarSrc: "https://cdn.example.com/avatars/jordan_s.jpg",
  url: "https://app.example.com/articles/optimizations",
  urlId: "articles-optimizations-402",
  key: "imported-2025-11-03-001",
  mentions: [{ id: "usr_204", tag: "@AishaK", rawTag: "@AishaK", type: "user", sent: true }],
  hashTags: [{ id: "ht_01", tag: "#performance", url: "https://app.example.com/tags/performance", retain: true }],
  rating: 5,
  pageTitle: "Performance Optimizations",
  isFromMyAccountPage: false
}];
const result: SaveComment200Response[] = await saveCommentsBulk(tenantId, createCommentParams, true, true, false, true);

putDomainConfig

PUT /api/v1/domain-configs/{domainToUpdate}

Parameters

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

Response

Returns: GetDomainConfig200Response

Example

putDomainConfig Example

Copy

const tenantId: string = 'tenant_8f3b2c';
const domainToUpdate: string = 'comments.news-site.com';
const updateDomainConfigParams: UpdateDomainConfigParams = {
  domain: 'comments.news-site.com',
  emailFromName: 'NewsSite Community',
  emailFromEmail: 'community@news-site.com',
  logoSrc: 'https://news-site.com/assets/logo.svg',
  logoSrc100px: 'https://news-site.com/assets/logo-100.png',
  footerUnsubscribeURL: 'https://news-site.com/unsubscribe',
  brandColor: '#003366',
  emailHeaders: { 'Reply-To': 'community@news-site.com', 'X-Mailer': 'FastComments' }
};
const result: GetDomainConfig200Response = await putDomainConfig(tenantId, domainToUpdate, updateDomainConfigParams);

unFlagComment

POST /api/v1/comments/{id}/un-flag

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 = 'acme-tenant-001';
const id: string = 'comment_5f3a9c2e';
const userId: string = 'user_7a1b2c3d';
const response: FlagComment200Response = await unFlagComment(tenantId, id, userId);

unBlockUserFromComment

POST /api/v1/comments/{id}/un-block

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_9f8b6a4c';
const id: string = 'comment_5b3a2f1e';
const unBlockFromCommentParams: UnBlockFromCommentParams = { commentIdsToCheck: ['comment_5b3a2f1e', 'comment_7e6d4a2b'] };
const userId: string = 'user_42a7c9';
const result: UnBlockCommentPublic200Response = await unBlockUserFromComment(tenantId, id, unBlockFromCommentParams, userId);

updateComment

PATCH /api/v1/comments/{id}

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 = 'tenant_8f3b2c';
const id: string = 'comment_9a7e1b';
const body: PickAPICommentUpdatableCommentFields = {
  date: new Date('2025-11-01T12:34:56Z'),
  urlId: 'site-news-2025-11-01',
  urlIdRaw: '/news/2025/11/01/example-piece',
  url: 'https://example.com/news/2025/11/01/example-piece',
  pageTitle: 'Example News: Major Update',
  userId: 'user_2468',
  commenterEmail: 'jane.doe@example.com',
  commenterName: 'Jane Doe',
  commenterLink: 'https://example.com/@janedoe',
  comment: 'Thanks for the detailed coverage — this clarified a lot for me.',
  commentHTML: '<p>Thanks for the detailed coverage — this clarified a lot for me.</p>',
  verified: true,
  approved: true,
  votes: 27,
  flagCount: 0,
  meta: { wpUserId: '42' }
};
const contextUserId: string = 'moderator_1357';
const doSpamCheck: boolean = true;
const isLive: boolean = true;
const result: FlagCommentPublic200Response = await updateComment(tenantId, id, body, contextUserId, doSpamCheck, isLive);

updateUserBadge

PUT /api/v1/user-badges/{id}

Parameters

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

Response

Returns: UpdateUserBadge200Response

Example

updateUserBadge Example

Copy

const tenantId: string = 'tenant_84b3a2';
const id: string = 'user_4f2a1c';
const updateUserBadgeParams: UpdateUserBadgeParams = { displayedOnComments: true };
const result: UpdateUserBadge200Response = await updateUserBadge(tenantId, id, updateUserBadgeParams);

putSSOUser

PUT /api/v1/sso-users/{id}

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-platform-tenant-01';
const id: string = 'sso_user_7d3a2c';
const updateAPISSOUserData: UpdateAPISSOUserData = {
  id: 'sso_user_7d3a2c',
  username: 'j.smith',
  email: 'j.smith@acme.com',
  displayName: 'John Smith',
  displayLabel: 'John S.',
  avatarSrc: 'https://cdn.acme.com/avatars/john_smith.png',
  websiteUrl: 'https://johnsmith.dev',
  signUpDate: 1625097600000,
  loginCount: 42,
  optedInNotifications: true,
  optedInSubscriptionNotifications: false,
  isAdminAdmin: false,
  groupIds: ['marketing-team', 'customer-success'],
  createdFromUrlId: 'signup_landing_03'
};
const updateComments: boolean = true;
const result: PutSSOUserAPIResponse = await putSSOUser(tenantId, id, updateAPISSOUserData, updateComments);

checkedCommentsForBlocked

GET /check-blocked-comments

Parameters

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

Response

Returns: CheckedCommentsForBlocked200Response

Example

checkedCommentsForBlocked Example

Copy

const tenantId: string = 'tenant_8421';
const commentIds: string = 'cmt_9a1b,cmt_4f2d,cmt_7z8y';
const ssoToken: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature';
const resultWithSSO: CheckedCommentsForBlocked200Response = await checkedCommentsForBlocked(tenantId, commentIds, ssoToken);
const resultWithoutSSO: CheckedCommentsForBlocked200Response = await checkedCommentsForBlocked(tenantId, commentIds);

createCommentPublic

POST /comments/{tenantId}

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_acme_001";
const urlId: string = "blog-post-2025-11-03";
const broadcastId: string = "broadcast_live_20251103_01";
const commentData: CommentData = {
  date: Date.now(),
  localDateString: new Date().toLocaleString(),
  localDateHours: new Date().getHours(),
  commenterName: "Jamie Parker",
  commenterEmail: "jamie.parker@example.com",
  comment: "Great article — the performance tips about caching were especially helpful.",
  url: "https://www.acmeblog.com/performance/caching-best-practices",
  urlId,
  avatarSrc: "https://cdn.acme.com/avatars/jamie.png",
  key: "client-frontend-xyz"
};
const sessionId: string = "sess_9f8e7d6c";
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9";
const result: CreateCommentPublic200Response = await createCommentPublic(tenantId, urlId, broadcastId, commentData, sessionId, sso);

createFeedPostPublic

POST /feed-posts/{tenantId}

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_82b1c9";
const createParams: CreateFeedPostParams = {
  title: "New product feature launch",
  contentHTML: "<p>Inline editing is now available for comments — try it out!</p>",
  media: [
    { title: "Feature screenshot", linkUrl: "https://cdn.example.com/screens/feat.jpg", sizes: [{ w: 1200, h: 800, src: "https://cdn.example.com/screens/feat.jpg" }] }
  ],
  links: [{ text: "Read release notes", title: "Release Notes", description: "Details on the launch", url: "https://blog.example.com/releases/inline-edit" }],
  fromUserId: "team_product_01",
  fromUserDisplayName: "Product Team",
  tags: ["product","launch"],
  key: "prod-launch-2025-11-03",
  meta: { env: "production", region: "us-east-1" }
};
const broadcastId: string = "broadcast_55a";
const sso: string = "sso_token_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9";
const result: CreateFeedPostPublic200Response = await createFeedPostPublic(tenantId, createParams, broadcastId, sso);

blockFromCommentPublic

POST /block-from-comment/{commentId}

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 = 'acme-newsroom';
const commentId: string = 'cmt-20251103-7af';
const publicBlockFromCommentParams: PublicBlockFromCommentParams = { commentIds: ['cmt-20251102-1a', 'cmt-20251101-2b'] };
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.fakeSignature';
const result: BlockFromCommentPublic200Response = await blockFromCommentPublic(tenantId, commentId, publicBlockFromCommentParams, sso);

deleteCommentPublic

DELETE /comments/{tenantId}/{commentId}

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-news-123';
const commentId: string = 'cmt_8f3b2a1';
const broadcastId: string = 'live_2025-11-03_987';
const editKey: string | undefined = 'edit_7x9y4z';
const sso: string | undefined = 'sso_jwt_token_eyJhbGci';
const result: DeleteCommentPublic200Response = await deleteCommentPublic(tenantId, commentId, broadcastId, editKey, sso);

updateFeedPost

PATCH /api/v1/feed-posts/{id}

Parameters

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

Response

Returns: FlagCommentPublic200Response

Example

updateFeedPost Example

Copy

const tenantId: string = 'tenant_47b2';
const id: string = 'post_9f4a3';
const feedPost: FeedPost = {
  id,
  tenantId,
  title: 'Weekly release notes — v2.4.1',
  fromUserId: 'user_22',
  fromUserDisplayName: 'Alex Rivera',
  fromUserAvatar: null,
  tags: ['release', 'frontend'],
  meta: {
    createdAt: new Date('2025-10-28T10:15:00Z'),
    contentHTML: '<p>Deployed performance fixes and accessibility improvements.</p>',
    media: [{ title: 'Release screenshot', linkUrl: 'https://cdn.example.com/releases/v2.4.1.png', sizes: [{ w: 1200, h: 630, src: 'https://cdn.example.com/releases/v2.4.1-1200.png' }] }],
    links: [{ text: 'Changelog', url: 'https://app.example.com/changelog/v2.4.1' }],
    reacts: { like: 42, commentCount: 3 }
  }
};
const result: FlagCommentPublic200Response = await updateFeedPost(tenantId, id, feedPost);

getCommentText

GET /comments/{tenantId}/{commentId}/text

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 = 'tenant_acme_01';
const commentId: string = 'comment_9a8b7c6d';
const editKey: string | undefined = 'edit_3f2e1d';
const sso: string | undefined = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
const result: GetCommentText200Response = await getCommentText(tenantId, commentId, editKey, sso);

deleteFeedPostPublic

DELETE /feed-posts/{tenantId}/{postId}

Parameters

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

Response

Returns: DeleteFeedPostPublic200Response

Example

deleteFeedPostPublic Example

Copy

(async () => {
  const tenantId: string = 'tenant_acme_production';
  const postId: string = 'post_6f3a9b';
  const broadcastId: string = 'broadcast_2025-11-03';
  const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sampleToken';
  const result: DeleteFeedPostPublic200Response = await deleteFeedPostPublic(tenantId, postId, broadcastId, sso);
  console.log(result);
})();

flagCommentPublic

POST /flag-comment/{commentId}

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 = 'site-8472-prod';
const commentId: string = 'cmt-9f3b21a4';
const ssoToken: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.signature';
const resultWithSSO: FlagCommentPublic200Response = await flagCommentPublic(tenantId, commentId, true, ssoToken);
const resultWithoutSSO: FlagCommentPublic200Response = await flagCommentPublic(tenantId, 'cmt-9f3b21a4', false);

deleteCommentVote

DELETE /comments/{tenantId}/{commentId}/vote/{voteId}

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_7c9a3f';
const commentId: string = 'cmt_f8b3d9c2';
const voteId: string = 'vote_v4a1b2c';
const urlId: string = 'news-site/2025/10/31/article-42';
const broadcastId: string = 'broadcast_20251031_001';
const editKey: string = 'edk_9f8a7b'; // optional
const sso: string = 'sso_token_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9'; // optional
const result: DeleteCommentVote200Response = await deleteCommentVote(tenantId, commentId, voteId, urlId, broadcastId, editKey, sso);

getCommentVoteUserNames

GET /comments/{tenantId}/{commentId}/votes

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 = 'news-site-123';
const commentId: string = 'cmt_987654321';
const dir: number = 1;
const ssoToken: string = 'sso-token-abcdef123456';
const resultWithSSO: GetCommentVoteUserNames200Response = await getCommentVoteUserNames(tenantId, commentId, dir, ssoToken);
const resultWithoutSSO: GetCommentVoteUserNames200Response = await getCommentVoteUserNames(tenantId, commentId, dir);

getUserNotificationCount

GET /user-notifications/get-count

Parameters

Name	Type	Required	Description
tenantId	string	Yes
sso	string	No

Response

Returns: GetUserNotificationCount200Response

Example

getUserNotificationCount Example

Copy

const tenantId1: string = "fastcomments_prod_42";
const response1: GetUserNotificationCount200Response = await getUserNotificationCount(tenantId1);
const tenantId2: string = "fastcomments_stage_07";
const ssoToken: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature";
const response2: GetUserNotificationCount200Response = await getUserNotificationCount(tenantId2, ssoToken);

getFeedPostsPublic

GET /feed-posts/{tenantId}

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_12345';
const afterId: string = 'post_98765';
const limit: number = 25;
const tags: string[] = ['news', 'sports'];
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.ssoPayload.signature';
const isCrawler: boolean = false;
const includeUserInfo: boolean = true;
const response: GetFeedPostsPublic200Response = await getFeedPostsPublic(
  tenantId,
  afterId,
  limit,
  tags,
  sso,
  isCrawler,
  includeUserInfo
);

getEventLog

GET /event-log/{tenantId}

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 = 'fastcomments_tenant_12';
const urlId: string = 'article_2025-11-03-42';
const userIdWS: string = 'ws_user_7382';
const startTime: number = Date.now() - 1000 * 60 * 60; // 1 hour ago
const endTime: number = Date.now();
const response: GetEventLog200Response = await getEventLog(tenantId, urlId, userIdWS, startTime, endTime);
const firstEventId: string | undefined = response.events[0]?.id;
const bannedUntil: number | undefined = response.bannedUntil;

getFeedPostsStats

GET /feed-posts/{tenantId}/stats

Parameters

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

Response

Returns: GetFeedPostsStats200Response

Example

getFeedPostsStats Example

Copy

const tenantId: string = 'acme-newsroom';
const postIds: Array<string> = ['f3b2e9c4-8a1d-4c6e-b2f0-9d2a7e5c1234', 'e1a2b3c4-5d6f-7a8b-9c0d-1e2f3a4b5c6d'];
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI0MjMifQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
const result: GetFeedPostsStats200Response = await getFeedPostsStats(tenantId, postIds, sso);

getGlobalEventLog

GET /event-log/global/{tenantId}

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_acme_001';
const urlId: string = 'content/article-4321';
const userIdWS: string = 'ws_user_8421';
const startTime: number = Math.floor(Date.now() - 1000 * 60 * 60 * 24); // 24 hours ago
const endTime: number = Math.floor(Date.now());
const result: GetEventLog200Response = await getGlobalEventLog(tenantId, urlId, userIdWS, startTime, endTime);
const recentEventCount: number = result.events.length;
const maxCommentLen: number | null | undefined = result.customConfig?.maxCommentCharacterLength;

getUserReactsPublic

GET /feed-posts/{tenantId}/user-reacts

Parameters

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

Response

Returns: GetUserReactsPublic200Response

Example

getUserReactsPublic Example

Copy

const tenantId: string = 'tenant_82f4d3';
const postIds: Array<string> = ['post_9f1c', 'post_7b2a'];
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sso_user_98765.signature';
const result: GetUserReactsPublic200Response = await getUserReactsPublic(tenantId, postIds, sso);

getUserPresenceStatuses

GET /user-presence-status

Parameters

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

Response

Returns: GetUserPresenceStatuses200Response

Example

getUserPresenceStatuses Example

Copy

const tenantId: string = 'tenant_9f3b2a';
const urlIdWS: string = 'wss://ws.fastcomments.com/room/9f3b2a';
const userIds: string = 'u_1023,u_2045,u_3098';
const presence: GetUserPresenceStatuses200Response = await getUserPresenceStatuses(tenantId, urlIdWS, userIds);
const isUser1023Online: boolean | undefined = presence.userIdsOnline?.['u_1023'];
const user1023Reason: string | undefined = presence.userIdsOnline?.reason;
const user1023SecondaryCode: string | undefined = presence.userIdsOnline?.secondaryCode;

lockComment

POST /comments/{tenantId}/{commentId}/lock

Parameters

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

Response

Returns: LockComment200Response

Example

lockComment Example

Copy

(async () => {
  const tenantId: string = 'tenant_9f3a2b7c';
  const commentId: string = 'cmt_4b8e91a2';
  const broadcastId: string = 'broadcast_live_2025-11-03';
  const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.fake_payload.signature';
  const response: LockComment200Response = await lockComment(tenantId, commentId, broadcastId, sso);
  console.log(response.status, response.reason);
})();

getUserNotifications

GET /user-notifications

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 notifications: GetUserNotifications200Response = await getUserNotifications(
  'tenant_7f3b2a9',
  20,
  'notification_98a7b3',
  true,
  Date.now() - 7 * 24 * 60 * 60 * 1000,
  true,
  false,
  false,
  true,
  'sso_jwt_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9'
);

getCommentsPublic

GET /comments/{tenantId}

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 response: GetCommentsPublic200Response = await getCommentsPublic(
  "tenant_8f4b2",
  "https://news.example.com/articles/2025/important-update",
  1,
  "MR",
  undefined,
  0,
  0,
  25,
  5,
  true,
  undefined,
  true,
  false,
  true,
  "en-US",
  "reactions,analytics",
  false,
  true,
  true,
  3,
  false,
  undefined,
  "climate change",
  ["breaking", "featured"],
  "user_9876",
  '{"theme":"compact"}',
  "cmt_12345",
  undefined
);

reactFeedPostPublic

POST /feed-posts/{tenantId}/react/{postId}

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 = 'acme-tenant-123';
const postId: string = 'post_78945';
const reactBodyParams: ReactBodyParams = { reactType: 'like' };
const isUndo: boolean = false;
const broadcastId: string = 'broadcast-2025-11-03-01';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.exampleSignature';
const result: ReactFeedPostPublic200Response = await reactFeedPostPublic(tenantId, postId, reactBodyParams, isUndo, broadcastId, sso);

searchUsers

GET /user-search/{tenantId}

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_live_981';
const urlId: string = 'news/2025/11/03/how-to-write-typescript';
const usernameStartsWith: string = 'jo';
const mentionGroupIds: string[] = ['editors', 'moderators'];
const sso: string = 'sso-token-2f9b7c3a';
const response: SearchUsers200Response = await searchUsers(tenantId, urlId, usernameStartsWith, mentionGroupIds, sso);

pinComment

POST /comments/{tenantId}/{commentId}/pin

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_live_84f1';
const commentId: string = 'cmt-9a3b2';
const broadcastId: string = 'broadcast_2025-11-03_stream1';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sso_payload.signature';
const pinnedResult: PinComment200Response = await pinComment(tenantId, commentId, broadcastId, sso);

resetUserNotifications

POST /user-notifications/reset

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_48a3f2';
const afterId: string = 'notif_20251103_001';
const afterCreatedAt: number = Date.now() - 86_400_000; // 24 hours ago
const unreadOnly: boolean = true;
const dmOnly: boolean = false;
const noDm: boolean = false;
const sso: string = 'sso-john.doe@company.com';
const result: ResetUserNotifications200Response = await resetUserNotifications(
  tenantId,
  afterId,
  afterCreatedAt,
  unreadOnly,
  dmOnly,
  noDm,
  sso
);

setCommentText

POST /comments/{tenantId}/{commentId}/update-text

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_7b2f9c';
const commentId: string = 'cmt_4921a';
const broadcastId: string = 'brd_sports_20251103';
const commentTextUpdateRequest: CommentTextUpdateRequest = {
  comment: 'Great point, @jane_doe — agreed with the analysis. #sports',
  mentions: [{ id: 'user_102', tag: '@jane_doe', rawTag: '@jane_doe', sent: true }],
  hashTags: [{ id: 'ht_7', tag: '#sports', url: 'https://example.com/tags/sports', retain: true }]
};
const editKey: string = 'edit_9f8d7c';
const sso: string = 'sso_tok_abc123';
const result: SetCommentText200Response = await setCommentText(tenantId, commentId, broadcastId, commentTextUpdateRequest, editKey, sso);

unBlockCommentPublic

DELETE /block-from-comment/{commentId}

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_84b2f1';
const commentId: string = 'cmt_9f3a21';
const publicBlockFromCommentParams: PublicBlockFromCommentParams = { commentIds: ['cmt_9f3a22', 'cmt_9f3a23'] };
const sso: string = 'sso_txn_7a8b9c';
const result: UnBlockCommentPublic200Response = await unBlockCommentPublic(tenantId, commentId, publicBlockFromCommentParams, sso);

unPinComment

POST /comments/{tenantId}/{commentId}/unpin

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_93f4b1';
const commentId: string = 'cmt_8a9f2d';
const broadcastId: string = 'broadcast_newsroom_20251103';
const ssoToken: string = 'sso_x9YzK6mN2b';
const result: PinComment200Response = await unPinComment(tenantId, commentId, broadcastId, ssoToken);

unLockComment

POST /comments/{tenantId}/{commentId}/unlock

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_83d4a2';
const commentId: string = 'cmt-5f9a1b3';
const broadcastId: string = 'broadcast-nyc-20251103';
const ssoToken: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.SSO_PAYLOAD.SIGN';
const resultWithSSO: LockComment200Response = await unLockComment(tenantId, commentId, broadcastId, ssoToken);
const resultNoSSO: LockComment200Response = await unLockComment(tenantId, commentId, broadcastId);

updateUserNotificationCommentSubscriptionStatus

POST /user-notifications/{notificationId}/mark-opted/{optedInOrOut}

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_4f2b9a';
const notificationId: string = 'notif_20251103_1';
const commentId: string = 'cmt_8a7f2c';
const optedInOrOut: UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum = UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum.OPTED_IN;
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.exampleSignature';
const result: UpdateUserNotificationStatus200Response = await updateUserNotificationCommentSubscriptionStatus(tenantId, notificationId, optedInOrOut, commentId, sso);

updateUserNotificationStatus

POST /user-notifications/{notificationId}/mark/{newStatus}

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 = 'tenant_7f3a2b9e';
const notificationId: string = 'notif_a3f4c1b7';
const newStatus: UpdateUserNotificationStatusNewStatusEnum = 'read' as UpdateUserNotificationStatusNewStatusEnum;
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.payload';
const response: UpdateUserNotificationStatus200Response = await updateUserNotificationStatus(tenantId, notificationId, newStatus, sso);

resetUserNotificationCount

POST /user-notifications/reset-count

Parameters

Name	Type	Required	Description
tenantId	string	Yes
sso	string	No

Response

Returns: ResetUserNotifications200Response

Example

resetUserNotificationCount Example

Copy

const tenantId: string = 'acme-tenant-9f2b';
const ssoToken: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI1Njc4OSIsImlhdCI6MTY4MDAwMDB9.signature';
const responseWithSSO: ResetUserNotifications200Response = await resetUserNotificationCount(tenantId, ssoToken);
const responseWithoutSSO: ResetUserNotifications200Response = await resetUserNotificationCount(tenantId);

updateFeedPostPublic

PUT /feed-posts/{tenantId}/{postId}

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 = "tenant_42f9b3";
const postId: string = "post_987cba";
const mediaItem: FeedPostMediaItem = {
  title: "Event photo",
  linkUrl: "https://cdn.example.com/events/2025/photo.jpg",
  sizes: [{ w: 1200, h: 800, src: "https://cdn.example.com/events/2025/photo.jpg" }]
};
const link: FeedPostLink = { text: "Full story", title: "Read more", url: "https://blog.example.com/event/2025" };
const updateFeedPostParams: UpdateFeedPostParams = {
  title: "Community Meetup Recap",
  contentHTML: "<p>Thanks to everyone who joined our meetup. Highlights and photos below.</p>",
  media: [mediaItem],
  links: [link],
  tags: ["community", "meetup", "2025"],
  meta: { source: "newsletter", publishedBy: "community_team" }
};
const broadcastId: string = "broadcast_20251103";
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...";
const result: CreateFeedPostPublic200Response = await updateFeedPostPublic(tenantId, postId, updateFeedPostParams, broadcastId, sso);

updateUserNotificationPageSubscriptionStatus

POST /user-notifications/set-subscription-state/{subscribedOrUnsubscribed}

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 = "tenant_8291";
const urlId: string = "article-759-election-2025-turnout";
const url: string = "https://www.dailyexample.com/politics/election-2025-turnout";
const pageTitle: string = "Election 2025: Voter Turnout Trends";
const subscribedOrUnsubscribed: UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum =
  "subscribed" as unknown as UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum;
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.exampleSignature";
const result: UpdateUserNotificationStatus200Response = await updateUserNotificationPageSubscriptionStatus(
  tenantId,
  urlId,
  url,
  pageTitle,
  subscribedOrUnsubscribed,
  sso
);

uploadImage

POST /upload-image/{tenantId}

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

enum SizePreset { Default = 'Default', CrossPlatform = 'CrossPlatform' }
enum APIStatus { success = 'success', failed = 'failed' }
type MediaAsset = { w: number; h: number; src: string };
type UploadImageResponse = { status: APIStatus; url?: string; media?: MediaAsset[]; reason?: string; code?: string };
const tenantId: string = 'tenant_9a7b4c';
const file: Blob = new Blob([new Uint8Array([255,216,255,224])], { type: 'image/jpeg' });
const sizePreset: SizePreset = SizePreset.CrossPlatform;
const urlId: string = 'post-2025-11-03';
const result: UploadImageResponse = await uploadImage(tenantId, file, sizePreset, urlId);

voteComment

POST /comments/{tenantId}/{commentId}/vote

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_42';
const commentId: string = 'cmt_987654321';
const urlId: string = 'news/article-2025-11-03';
const broadcastId: string = 'broadcast_01';
const voteBodyParams: VoteBodyParams = {
  commenterEmail: 'reader@example.com',
  commenterName: 'Jordan Blake',
  voteDir: 'up' as unknown as VoteBodyParamsVoteDirEnum,
  url: 'https://news.example.com/article/2025/11/03'
};
const sessionId: string = 'sess_4f3a2b';
const sso: string = 'sso_jwt_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
const result: VoteComment200Response = await voteComment(tenantId, commentId, urlId, broadcastId, voteBodyParams, sessionId, 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

Api

Misc Apis

FastComments JavaScript/TypeScript SDK

Repository

Installation

Installation

API Documentation

API Documentation

Browser vs Server Compatibility

Browser vs Server Compatibility

Usage

Usage

Browser Usage (Client-Side)

Server Usage (Node.js)

Types Only Import

Using Individual API Classes

Browser Environment

Server Environment

Public vs Secured APIs

Public vs Secured APIs

Example: Using Public API (browser-safe)

Example: Using Default API (server-side only)

SSO (Single Sign-On) Integration

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

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)

Live Events (Real-time Updates)

Page-Level Events

Subscribe to User Events

Getting userIdWS

Broadcast IDs

Broadcast IDs

Error Handling

Error Handling

TypeScript Support

TypeScript Support

bulkAggregateQuestionResults

Parameters

Response

Example

createFeedPost

Parameters

Response

Example

blockUserFromComment

Parameters

Response

Example

createSubscription

Parameters

Response

Example

aggregateQuestionResults

Parameters

Response

Example

addSSOUser

Parameters

Response

Example

addPage

Parameters

Response

Example

aggregate

Parameters

Response