FastComments JavaScript/TypeScript SDK

Dit is de officiële JavaScript/TypeScript SDK voor FastComments.

Officiële JavaScript/TypeScript SDK voor de FastComments API

Repository

Installatie

npm install fastcomments-sdk

API-documentatie

Volledige API-referentie: docs/api/README.md

Browser- vs Server-compatibiliteit

Deze SDK gebruikt dubbele toegangspunten om optimale compatibiliteit te waarborgen en runtime-fouten te voorkomen:

fastcomments-sdk/browser - Browserveilige versie met native fetch
fastcomments-sdk/server - Volledige Node.js-versie met SSO-ondersteuning
fastcomments-sdk (standaard) - Alleen types, veilig om overal te importeren

Gebruik

Deze SDK biedt afzonderlijke toegangspunten voor browser- en serveromgevingen om optimale compatibiliteit en beveiliging te garanderen:

Browsergebruik (Client-Side)

Voor browser/frontend-applicaties, gebruik de browserveilige export die Node.js-afhankelijkheden uitsluit:

// Browser-veilige import (geen Node.js-afhankelijkheden)
import { createFastCommentsBrowserSDK } from 'fastcomments-sdk/browser';

// Maak een browser SDK-instantie
const sdk = createFastCommentsBrowserSDK({
  basePath: 'https://fastcomments.com' // optional, defaults to https://fastcomments.com
});

// Gebruik openbare API's (geen API-sleutel nodig - veilig voor browsers)
const comments = await sdk.publicApi.getCommentsPublic({ 
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Servergebruik (Node.js)

Voor server/backend-applicaties, gebruik de volledige SDK met SSO- en authenticatiefuncties:

// Server-side import (inclusief SSO en ontworpen om te werken met NodeJS)
import { createFastCommentsSDK } from 'fastcomments-sdk/server';

// Maak een server SDK-instantie
const sdk = createFastCommentsSDK({
  apiKey: 'your-api-key', // Houd dit geheim op de server!
  basePath: 'https://fastcomments.com' // optional, defaults to https://fastcomments.com
});

// Gebruik beveiligde API's met uw API-sleutel
const comments = await sdk.defaultApi.getComments({ 
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Alleen types importeren

Als u alleen TypeScript-typen nodig heeft (geen runtime-code), gebruik dan de standaardimport:

// Alleen types (geen runtime-afhankelijkheden - overal veilig)
import type { 
  PublicComment, 
  CreateCommentParams, 
  GetCommentsPublic200Response 
} from 'fastcomments-sdk';

Gebruik van individuele API-klassen

Browseromgeving

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

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

const publicApi = new PublicApi(config);

Serveromgeving

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

Openbare vs beveiligde API's

De SDK biedt drie hoofd-API-klassen:

DefaultApi - Beveiligde endpoints die uw API-sleutel vereisen voor authenticatie. Gebruik deze voor serverzijde-bewerkingen.
PublicApi - Publieke endpoints die kunnen worden benaderd zonder API-sleutel. Deze kunnen rechtstreeks vanuit browsers/mobiele apparaten/etc. worden aangeroepen.
HiddenApi - Interne/admin endpoints voor geavanceerde gebruikssituaties.

Voorbeeld: Public API gebruiken (browser-veilig)

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

const publicApi = new PublicApi();

// Haal reacties op voor een pagina (geen API-sleutel vereist)
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Voorbeeld: Default API gebruiken (alleen serverzijde)

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

const config = new Configuration({
  apiKey: 'your-api-key' // Houd dit geheim!
});
const defaultApi = new DefaultApi(config);

// Haal reacties op met volledige beheerdersrechten
const response = await defaultApi.getComments({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

SSO (Single Sign-On) integratie

FastComments ondersteunt SSO om te integreren met uw bestaande gebruikersauthenticatiesysteem. SSO-functionaliteit is alleen beschikbaar in de server-export omdat het Node.js crypto-functies vereist.

Eenvoudige SSO (Alleen serverzijde)

Eenvoudige SSO moet aan de serverzijde worden gegenereerd en naar de client worden gestuurd:

// Code aan de serverzijde (Node.js/backend)
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

// Maak eenvoudige SSO met de ingebouwde 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();

// Stuur ssoToken naar uw client-side code
// Client-side code kan dit token vervolgens gebruiken met de browser SDK

Beveiligde SSO (Server-side, aanbevolen)

Beveiligde SSO moet aan de serverzijde worden geïmplementeerd en biedt betere beveiliging:

// Code aan de serverzijde (Node.js/backend)
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

// Maak beveiligde SSO met de ingebouwde 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();

// Gebruik met API-aanroepen op de server
const publicApi = new PublicApi();
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
  sso: JSON.stringify(ssoConfig)
});

// Of stuur ssoConfig naar de client voor gebruik in de browser

SSO gebruiken vanuit de browser (met door de server gegenereerd token)

// Code aan de clientzijde (browser)
import { PublicApi } from 'fastcomments-sdk/browser';

// Haal SSO-token op van uw 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 // Gebruik het door de server gegenereerde SSO-token
});

SSO met het aanmaken van een reactie

// Server-side: Maak SSO en reactie
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)
});

Veelvoorkomende gebruiksgevallen

Reacties ophalen voor een pagina

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

Een reactie aanmaken

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

Stemmen op een reactie

const voteResponse = await sdk.publicApi.voteComment({
  voteBodyParams: {
    commentId: 'comment-id',
    direction: 1 // 1 voor omhoog stemmen, -1 voor omlaag stemmen
  }
});

Gebruikersbeheer (vereist API-sleutel)

// Zoeken naar gebruikers (vereist DefaultApi)
const users = await sdk.defaultApi.searchUsers({
  tenantId: 'your-tenant-id',
  urlId: 'page-id',
  usernameStartsWith: 'john'
});

Live-evenementen (Realtime-updates)

Abonneer op live-evenementen om realtime updates te ontvangen voor reacties, stemmen en andere activiteiten.

Paginaniveau-evenementen

Luister naar live-evenementen op een specifieke pagina (reacties, stemmen, enz.):

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

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

// Abonneer op live-evenementen voor een pagina
const subscription = subscribeToChanges(
  config,
  'your-tenant-id', // tenantIdWS
  'page-url-id',    // urlIdWS  
  'user-session-id', // userIdWS (haal dit uit het antwoord van getComments)
  (event: LiveEvent) => {
    console.log('Live event received:', event);

    switch (event.type) {
      case LiveEventType.new_comment:
        console.log('New comment:', event.comment);
        // Werk je UI bij met de nieuwe reactie
        break;
      case LiveEventType.new_vote:
        console.log('New vote:', event.vote);
        // Werk de stemaantallen in je UI bij
        break;
      case LiveEventType.updated_comment:
        console.log('Comment updated:', event.comment);
        break;
      default:
        console.log('Other event type:', event.type);
    }

    return true; // Geef true terug als het event is verwerkt
  },
  (isConnected: boolean) => {
    console.log('Connection status:', isConnected ? 'Connected' : 'Disconnected');
  }
);

// Sluit de subscription wanneer klaar
subscription.close();

Abonneer op gebruikersgebeurtenissen

Luister naar gebruiker-specifieke gebeurtenissen (meldingen, vermeldingen, enz.):

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

const userConfig = {
  userIdWS: 'user-session-id', // Verkrijg dit uit het antwoord van getComments
};

// Abonneer op de persoonlijke feed van de gebruiker
const userSubscription = subscribeToUserFeed(
  userConfig,
  (event: LiveEvent) => {
    console.log('User event received:', event);

    switch (event.type) {
      case LiveEventType.notification:
        console.log('New notification:', event.notification);
        // Toon melding in je 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');
  }
);

// Sluit wanneer klaar
userSubscription.close();

Het verkrijgen van userIdWS

De userIdWS-parameter is vereist voor live-evenementen en kan worden verkregen uit API-responses:

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

// Extraheer userIdWS uit het antwoord
const userIdWS = response.data?.userSessionInfo?.userIdWS;

if (userIdWS) {
  // Nu kun je je abonneren op live-evenementen
  const subscription = subscribeToChanges(config, tenantIdWS, urlIdWS, userIdWS, handleEvent);
}

Broadcast-ID's

Je ziet dat je in sommige API-aanroepen een broadcastId moet doorgeven. Wanneer je events ontvangt, krijg je deze ID terug, zodat je het event kunt negeren als je van plan bent om wijzigingen optimistisch op de client toe te passen (wat je waarschijnlijk wilt doen omdat het de beste ervaring biedt). Geef hier een UUID door. De ID moet uniek genoeg zijn om niet twee keer in een browsersessie voor te komen.

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() // Unieke ID voor deze bewerking
  }
});

Foutafhandeling

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

aggregate

Aggregeert documenten door ze te groeperen (als groupBy wordt opgegeven) en meerdere bewerkingen toe te passen. Verschillende bewerkingen (bijv. sum, countDistinct, avg, etc.) worden ondersteund.

Parameters

Naam	Type	Vereist
tenantId	string	Ja
aggregationRequest	AggregationRequest	Ja
parentTenantId	string	Nee
includeStats	boolean	Nee

Antwoord

Retourneert: AggregationResponse

getAuditLogs

Parameters

Naam	Type	Vereist
tenantId	string	Ja
limit	number	Nee
skip	number	Nee
order	SORTDIR	Nee
after	number	Nee
before	number	Nee

Antwoord

Geeft terug: GetAuditLogs200Response

Voorbeeld

getAuditLogs Voorbeeld

Copy

async function main(): Promise<void> {
  const tenantId: string = 'tenant_9b8f6c';
  const limit: number = 50;
  const skip: number = 0;
  const order: SORTDIR = 'desc';
  const after: number = Date.now() - 7 * 24 * 60 * 60 * 1000;
  const response: GetAuditLogs200Response = await getAuditLogs(tenantId, limit, skip, order, after);
  console.log(response);
}
main();

blockFromCommentPublic

Parameters

Naam	Type	Vereist
tenantId	string	Ja
commentId	string	Ja
publicBlockFromCommentParams	PublicBlockFromCommentParams	Ja
sso	string	Nee

Response

Geeft terug: BlockFromCommentPublic200Response

Voorbeeld

blockFromCommentPublic Voorbeeld

Copy

const tenantId: string = "site_7f9b2e";
const commentId: string = "comment_2026-03-25_001";
const publicBlockFromCommentParams: PublicBlockFromCommentParams = {
  reason: "Repeated harassment and targeted abuse",
  blockDurationDays: 90,
  includeHistory: true,
  notifyModeratorTeam: true
};
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.fakePayload.signature";
const result: BlockFromCommentPublic200Response = await blockFromCommentPublic(tenantId, commentId, publicBlockFromCommentParams, sso);

unBlockCommentPublic

Parameters

Naam	Type	Vereist
tenantId	string	Ja
commentId	string	Ja
publicBlockFromCommentParams	PublicBlockFromCommentParams	Ja
sso	string	Nee

Respons

Retourneert: UnBlockCommentPublic200Response

Voorbeeld

unBlockCommentPublic Voorbeeld

Copy

const tenantId: string = 'tenant_42e8a1';
const commentId: string = 'cmt_9b3f2d';
const publicBlockFromCommentParams: PublicBlockFromCommentParams = {
  reason: 'abusive_language',
  blockedByModeratorId: 'mod_17',
  note: 'Targeted harassment; review complete',
  unblockRequestedAt: new Date().toISOString()
};
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature';
const result: UnBlockCommentPublic200Response = await unBlockCommentPublic(tenantId, commentId, publicBlockFromCommentParams, sso);

checkedCommentsForBlocked

Parameters

Name	Type	Vereist
tenantId	string	Ja
commentIds	string	Ja
sso	string	Nee

Respons

Retourneert: CheckedCommentsForBlocked200Response

Voorbeeld

checkedCommentsForBlocked Voorbeeld

Copy

const tenantId: string = 'tenant_4f3b2a1e';
const commentIds: string = 'c_1001,c_1002,c_1003';
const ssoToken: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyMTIzIn0.Sf4ke7nQP3mZx9v2';
const resultWithoutSSO: CheckedCommentsForBlocked200Response = await checkedCommentsForBlocked(tenantId, commentIds);
const resultWithSSO: CheckedCommentsForBlocked200Response = await checkedCommentsForBlocked(tenantId, commentIds, ssoToken);

blockUserFromComment

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
id	string	Ja
blockFromCommentParams	BlockFromCommentParams	Ja
userId	string	Nee
anonUserId	string	Nee

Respons

Retourneert: BlockFromCommentPublic200Response

Voorbeeld

blockUserFromComment Voorbeeld

Copy

const tenantId: string = "tenant_12345";
const id: string = "comment_67890";
const blockFromCommentParams: BlockFromCommentParams = {
  reason: "Repeated abusive language",
  blockDurationHours: 168,
  blockReplies: true,
  notifyAuthor: true
};
const userId: string = "user_abc123";
const anonUserId: string = "anon_xyz789";
const result: BlockFromCommentPublic200Response = await blockUserFromComment(tenantId, id, blockFromCommentParams, userId, anonUserId);

createCommentPublic

Parameters

Name	Type	Required
tenantId	string	Ja
urlId	string	Ja
broadcastId	string	Ja
commentData	CommentData	Ja
sessionId	string	Nee
sso	string	Nee

Respons

Geeft terug: CreateCommentPublic200Response

Voorbeeld

createCommentPublic Voorbeeld

Copy

const tenantId: string = 'tenant_prod_42';
const urlId: string = 'article-2026-03-25-tech-deep-dive';
const broadcastId: string = 'live-broadcast-001';
const sessionId: string = 'sess_9f8e7d6a3b';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature';
const commentData: CommentData = {
  content: 'Great reporting — appreciated the depth on performance tradeoffs.',
  authorName: 'Jordan M.',
  language: 'en-US',
  metadata: { client: 'web' }
};
const result: CreateCommentPublic200Response = await createCommentPublic(tenantId, urlId, broadcastId, commentData, sessionId, sso);

deleteComment

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Ja
contextUserId	string	Nee
isLive	boolean	Nee

Response

Retourneert: DeleteComment200Response

Voorbeeld

deleteComment Voorbeeld

Copy

const tenantId: string = 'tenant_7b3f2a';
const commentId: string = 'cmt_8a1f4d2b';
const contextUserId: string = 'user_102';
const isLive: boolean = true;
const result: DeleteComment200Response = await deleteComment(tenantId, commentId, contextUserId, isLive);

deleteCommentPublic

Parameters

Naam	Type	Vereist
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	Yes
editKey	string	No
sso	string	No

Respons

Retourneert: DeleteCommentPublic200Response

Voorbeeld

deleteCommentPublic Voorbeeld

Copy

const tenantId: string = 'tenant_4f2c9b';
const commentId: string = 'comment-7c3a9f2d';
const broadcastId: string = 'article-2026-03-20';
const editKey: string | undefined = 'ek_pub_abc12345';
const sso: string | undefined = 'sso_eyJhbGciOiJIUzI1Ni';
const result: DeleteCommentPublic200Response = await deleteCommentPublic(
  tenantId,
  commentId,
  broadcastId,
  editKey,
  sso
);

deleteCommentVote

Parameters

Naam	Type	Vereist
tenantId	string	Ja
commentId	string	Ja
voteId	string	Ja
urlId	string	Ja
broadcastId	string	Ja
editKey	string	Nee
sso	string	Nee

Respons

Retourneert: DeleteCommentVote200Response

Voorbeeld

deleteCommentVote Voorbeeld

Copy

const tenantId: string = 'acme-tenant-87e4fd';
const commentId: string = 'cmt-9a12b3f4';
const voteId: string = 'vote-4f6d21b9';
const urlId: string = 'https://www.acme.com/articles/2026/03/25/how-to-test';
const broadcastId: string = 'broadcast-20260325-01';
const editKey: string = 'editkey-6b7c8d9e';
const sso: string = 'sso-jwt-eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
const response: DeleteCommentVote200Response = await deleteCommentVote(
  tenantId,
  commentId,
  voteId,
  urlId,
  broadcastId,
  editKey,
  sso
);

flagComment

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Ja
userId	string	Nee
anonUserId	string	Nee

Respons

Retourneert: FlagComment200Response

Voorbeeld

flagComment Voorbeeld

Copy

const tenantId: string = 'tenant_acme_001';
const id: string = 'comment_7f3a2b9e';
const userId: string = 'user_jdoe_1001';
const anonUserId: string = 'anon_3f2b_visitor';
const result: FlagComment200Response = await flagComment(tenantId, id, userId, anonUserId);

getComment

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Ja

Respons

Retourneert: GetComment200Response

Voorbeeld

getComment Voorbeeld

Copy

const tenantId: string = "acme-publishing-001";
const commentId: string = "f3b2c1d0-9a8e-4b7c-8123-6d5f0a1e2b3c";
const result: GetComment200Response = await getComment(tenantId, commentId);
const wrapper: GetComment200Response & { comment?: APIComment } = result;
const comment: APIComment | undefined = wrapper.comment;
const authorBadge: CommentUserBadgeInfo | undefined = comment?.user?.badge;
const userHashTags: CommentUserHashTagInfo[] | undefined = comment?.user?.hashTags

getComments

Parameters

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

Respons

Retourneert: GetComments200Response

Voorbeeld

getComments Voorbeeld

Copy

const tenantId: string = 'tenant_acme_42';
const response: GetComments200Response = await getComments(
  tenantId,
  1, // pagina (page)
  20, // limiet (limit)
  0, // overslaan (skip)
  true, // als boom (asTree)
  1, // kinderen overslaan (skipChildren)
  3, // limiet voor kinderen (limitChildren)
  4, // maximale boomdiepte (maxTreeDepth)
  'articles/2026/new-product-launch', // URL-id (urlId)
  'user_7890', // gebruiker-id (userId)
  'anon_4f3b2', // anonieme gebruiker-id (anonUserId)
  undefined, // context gebruiker-id (contextUserId)
  '#launch', // hashtag (hashTag)
  undefined // ouder-id (parentId)
);

getCommentsPublic

req tenantId urlId

Parameters

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

Respons

Geeft terug: GetCommentsPublic200Response

Voorbeeld

getCommentsPublic Voorbeeld

Copy

const tenantId: string = 'tenant_eu-west_01';
const urlId: string = 'https://www.financialtimes.com/articles/2026/market-update-q1';
const response: GetCommentsPublic200Response = await getCommentsPublic(
  tenantId,
  urlId,
  2,
  undefined,
  'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.tokenPayload.signature',
  undefined,
  0,
  50,
  5,
  true,
  undefined,
  true,
  false,
  true,
  'en-US',
  'reactions,moderation',
  false,
  true,
  true,
  3,
  false,
  undefined,
  'performance',
  ['feature','fastcomments'],
  'user_9876',
  undefined,
  undefined,
  undefined
);

getCommentText

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
commentId	string	Ja
editKey	string	Nee
sso	string	Nee

Antwoord

Retourneert: GetCommentText200Response

Voorbeeld

getCommentText Voorbeeld

Copy

const tenantId: string = 'tenant_acme_001';
const commentId: string = 'cmt_7890b';
const editKey: string = 'edit_4f2d9b7c';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
const result: GetCommentText200Response = await getCommentText(tenantId, commentId, editKey, sso);

getCommentVoteUserNames

Parameters

Naam	Type	Vereist
tenantId	string	Yes
commentId	string	Yes
dir	number	Yes
sso	string	No

Respons

Retourneert: GetCommentVoteUserNames200Response

Voorbeeld

getCommentVoteUserNames Voorbeeld

Copy

(async () => {
  const tenantId: string = 'tenant_4f2c1e';
  const commentId: string = 'cmt_9a7b3d';
  const dir: number = 1;
  const resultUpvotes: GetCommentVoteUserNames200Response = await getCommentVoteUserNames(tenantId, commentId, dir);
  const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.fakepayload.signature';
  const dirDown: number = -1;
  const resultDownvotes: GetCommentVoteUserNames200Response = await getCommentVoteUserNames(tenantId, commentId, dirDown, sso);
  console.log(resultUpvotes, resultDownvotes);
})();

lockComment

Parameters

Name	Type	Required
tenantId	string	Ja
commentId	string	Ja
broadcastId	string	Ja
sso	string	Nee

Respons

Retourneert: LockComment200Response

Voorbeeld

lockComment Voorbeeld

Copy

const tenantId: string = "tenant_prod_8f3a2b";
const commentId: string = "cmt_5d7e9a92";
const broadcastId: string = "broadcast_2026_03_25_1400";
const ssoToken: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature";
const resultWithSso: LockComment200Response = await lockComment(tenantId, commentId, broadcastId, ssoToken);
const resultWithoutSso: LockComment200Response = await lockComment(tenantId, commentId, broadcastId);

pinComment

Parameters

Naam	Type	Vereist
tenantId	string	Ja
commentId	string	Ja
broadcastId	string	Ja
sso	string	Nee

Respons

Retourneert: PinComment200Response

Voorbeeld

pinComment Voorbeeld

Copy

const tenantId: string = "tenant_4f2b9a";
const commentId: string = "cmt_9f8e7d6c";
const broadcastId: string = "brd_live_concert_2026-03-25";
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sso_payload_signature";
const result: PinComment200Response = await pinComment(tenantId, commentId, broadcastId, sso);

saveComment

Parameters

Naam	Type	Vereist
tenantId	string	Ja
createCommentParams	CreateCommentParams	Ja
isLive	boolean	Nee
doSpamCheck	boolean	Nee
sendEmails	boolean	Nee
populateNotifications	boolean	Nee

Respons

Retourneert: SaveComment200Response

Voorbeeld

saveComment Voorbeeld

Copy

const tenantId: string = 'tenant_acme_001';
const createCommentParams: CreateCommentParams = {
  content: 'Great article — helped me fix a production issue in minutes.',
  url: 'https://app.acme.com/blog/performance-tips',
  author: { name: 'Maya Chen', email: 'maya.chen@acme.com' },
  metadata: { locale: 'en-US', appVersion: '4.2.1' }
} as CreateCommentParams;
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);

saveCommentsBulk

Parameters

Naam	Type	Vereist
tenantId	string	Ja
createCommentParams	Array	Ja
isLive	boolean	Nee
doSpamCheck	boolean	Nee
sendEmails	boolean	Nee
populateNotifications	boolean	Nee

Respons

Retourneert: Array<SaveComment200Response

Voorbeeld

saveCommentsBulk Voorbeeld

Copy

const tenantId: string = 'acme-corp-01';
const mentions1: CommentUserMentionInfo[] = [{ userId: 'user-123', displayName: 'Jane Doe' }];
const hashtags1: CommentUserHashTagInfo[] = [{ tag: 'typescript' }];
const createCommentParams: CreateCommentParams[] = [
  {
    content: 'Great insights on async/await patterns.',
    authorName: 'John Smith',
    authorEmail: 'john.smith@acme.com',
    externalId: 'comment-001',
    createdAt: '2026-03-25T10:15:00Z',
    userMentions: mentions1,
    userHashTags: hashtags1
  },
  {
    content: 'I prefer using Promise.all for bulk ops.',
    authorName: 'Emily Turner',
    authorEmail: 'emily.turner@acme.com',
    externalId: 'comment-002',
    createdAt: '2026-03-25T10:20:00Z'
  }
];
const result: SaveComment200Response[] = await saveCommentsBulk(tenantId, createCommentParams, true, true, false, true);

setCommentText

Parameters

Naam	Type	Vereist
tenantId	string	Ja
commentId	string	Ja
broadcastId	string	Ja
commentTextUpdateRequest	CommentTextUpdateRequest	Ja
editKey	string	Nee
sso	string	Nee

Antwoord

Retourneert: SetCommentText200Response

Voorbeeld

setCommentText Voorbeeld

Copy

const tenantId: string = 'tenant_6721f4';
const commentId: string = 'cmt_9a3b2d';
const broadcastId: string = 'live_2026_03_25';
const editKey: string = 'edit_k_4f7b9';
const sso: string = 'sso_tok_eyJhbGciOiJIUzI1';
const commentTextUpdateRequest: CommentTextUpdateRequest = {
  text: 'Updated to clarify the timeline and link the relevant docs.',
  mentions: [{ userId: 'user_102', displayName: 'Alex Rivera' }],
  hashtags: [{ tag: 'product-update' }]
};
const result: SetCommentText200Response = await setCommentText(tenantId, commentId, broadcastId, commentTextUpdateRequest, editKey, sso);

unBlockUserFromComment

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Ja
unBlockFromCommentParams	UnBlockFromCommentParams	Ja
userId	string	Nee
anonUserId	string	Nee

Response

Retourneert: UnBlockCommentPublic200Response

Voorbeeld

unBlockUserFromComment Voorbeeld

Copy

const tenantId: string = 'tenant_87f3e1';
const id: string = 'comment_9b2a4f';
const unBlockFromCommentParams: UnBlockFromCommentParams = {
  reason: 'Reviewed by moderation team — reinstated',
  moderatorId: 'mod_21',
  unblockedAt: new Date().toISOString()
};
const userId: string = 'user_42';
const anonUserId: string = 'anon_e7f9';
const result: UnBlockCommentPublic200Response = await unBlockUserFromComment(tenantId, id, unBlockFromCommentParams, userId, anonUserId);

unFlagComment

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Ja
userId	string	Nee
anonUserId	string	Nee

Respons

Retourneert: FlagComment200Response

Voorbeeld

unFlagComment Voorbeeld

Copy

const tenantId: string = 'acme-tenant-001';
const commentId: string = 'cmt_9f8e7d6c';
const userId: string = 'user_72b4a1c9';
const anonUserId: string = 'anon_3d2c1b0a';
const response: FlagComment200Response = await unFlagComment(tenantId, commentId, userId, anonUserId);

unLockComment

Parameters

Naam	Type	Vereist
tenantId	string	Ja
commentId	string	Ja
broadcastId	string	Ja
sso	string	Nee

Respons

Retourneert: LockComment200Response

Voorbeeld

unLockComment Voorbeeld

Copy

const tenantId: string = 'tenant_9d4f2b';
const commentId: string = 'cmt_8a3e1f';
const broadcastId: string = 'broadcast_2026_03_25';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature';
const result: LockComment200Response = await unLockComment(tenantId, commentId, broadcastId, sso);

unPinComment

Parameters

Naam	Type	Vereist
tenantId	string	Ja
commentId	string	Ja
broadcastId	string	Ja
sso	string	Nee

Respons

Geeft terug: PinComment200Response

Voorbeeld

unPinComment Voorbeeld

Copy

const tenantId: string = 'tenant_7f9d2a3b';
const commentId: string = 'comment_842b9c1f';
const broadcastId: string = 'bcast_frontpage_202603';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.exampleSignature';
const result: PinComment200Response = await unPinComment(tenantId, commentId, broadcastId, sso);

updateComment

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Ja
updatableCommentParams	UpdatableCommentParams	Ja
contextUserId	string	Nee
doSpamCheck	boolean	Nee
isLive	boolean	Nee

Respons

Retourneert: FlagCommentPublic200Response

Voorbeeld

updateComment Voorbeeld

Copy

const tenantId: string = "tenant_acme_corp_01";
const id: string = "comment_20260325_4592";
const updatableCommentParams: UpdatableCommentParams = {
  body: "Updated the response to include a link to the RFC and fixed a typo in the second paragraph.",
  editedByUserId: "user_8721",
  isVisible: true
};
const contextUserId: string = "user_8721";
const doSpamCheck: boolean = true;
const isLive: boolean = true;
const result: FlagCommentPublic200Response = await updateComment(tenantId, id, updatableCommentParams, contextUserId, doSpamCheck, isLive);

voteComment

Parameters

Naam	Type	Vereist
tenantId	string	Ja
commentId	string	Ja
urlId	string	Ja
broadcastId	string	Ja
voteBodyParams	VoteBodyParams	Ja
sessionId	string	Nee
sso	string	Nee

Reactie

Retourneert: VoteComment200Response

Voorbeeld

voteComment Voorbeeld

Copy

const tenantId: string = 'tenant_9f8b7c';
const commentId: string = 'cmt_42f3a1';
const urlId: string = 'articles/ai-trends-2026';
const broadcastId: string = 'web';
const voteBodyParams: VoteBodyParams = { vote: 1, reason: 'Insightful and on-topic' };
const sessionId: string = 'sess_6d2b4c9e';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
const result: VoteComment200Response = await voteComment(tenantId, commentId, urlId, broadcastId, voteBodyParams, sessionId, sso);

addDomainConfig

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
addDomainConfigParams	AddDomainConfigParams	Ja

Respons

Retourneert: AddDomainConfig200Response

deleteDomainConfig

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
domain	string	Ja

Respons

Geeft terug: DeleteDomainConfig200Response

getDomainConfig

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
domain	string	Ja

Antwoord

Retourneert: GetDomainConfig200Response

getDomainConfigs

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja

Antwoord

Retourneert: GetDomainConfigs200Response

patchDomainConfig

Parameters

Naam	Type	Vereist
tenantId	string	Ja
domainToUpdate	string	Ja
patchDomainConfigParams	PatchDomainConfigParams	Ja

Respons

Retourneert: GetDomainConfig200Response

putDomainConfig

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
domainToUpdate	string	Ja
updateDomainConfigParams	UpdateDomainConfigParams	Ja

Respons

Retourneert: GetDomainConfig200Response

createEmailTemplate

Parameters

Name	Type	Required	Description
tenantId	string	Ja
createEmailTemplateBody	CreateEmailTemplateBody	Ja

Respons

Retourneert: CreateEmailTemplate200Response

Voorbeeld

createEmailTemplate Voorbeeld

Copy

const tenantId: string = "tenant_7a9f3c2b";
const customConfig: CustomConfigParameters = { smtpHost: "smtp.fastmail.com", smtpPort: 587, useTLS: true };
const createEmailTemplateBody: CreateEmailTemplateBody = {
  name: "Account Notification",
  subject: "Your ACME account was updated",
  fromEmail: "no-reply@acme-corp.com",
  replyTo: "support@acme-corp.com",
  html: "<p>Hi {{user.firstName}}, your account settings were changed.</p>",
  text: "Hi {{user.firstName}}, your account settings were changed.",
  isActive: true,
  description: "Used for transactional account update emails",
  customConfig
};
const result: CreateEmailTemplate200Response = await createEmailTemplate(tenantId, createEmailTemplateBody);

deleteEmailTemplate

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Ja

Antwoord

Retourneert: FlagCommentPublic200Response

Voorbeeld

deleteEmailTemplate Voorbeeld

Copy

const tenantId: string = 'tenant_7f4c9d1e';
const templateId: string = 'tmpl_welcome_2024-03';
const notifyAdmin: boolean | undefined = true; // voorbeeld van optionele parameter
const result: FlagCommentPublic200Response = await deleteEmailTemplate(tenantId, templateId);

deleteEmailTemplateRenderError

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Ja
errorId	string	Ja

Antwoord

Retourneert: FlagCommentPublic200Response

Voorbeeld

deleteEmailTemplateRenderError Voorbeeld

Copy

const tenantId: string = 'tenant_7f3b4c2a';
const templateEnvironment: string | undefined = 'production'; // optionele omgevingkeuze
const id: string = `emailTemplates/${templateEnvironment ?? 'staging'}/welcome_v2`;
const errorId: string = 'err_5a9d2f1c';
const result: FlagCommentPublic200Response = await deleteEmailTemplateRenderError(tenantId, id, errorId);
console.log(result);

getEmailTemplate

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Ja

Antwoord

Retourneert: GetEmailTemplate200Response

Voorbeeld

Voorbeeld van getEmailTemplate

Copy

const tenantId: string = "acme-marketing-042";
const templateId: string = "tpl_welcome_2026";
const result: GetEmailTemplate200Response = await getEmailTemplate(tenantId, templateId);
const template: CustomEmailTemplate | undefined = result.template;
const subject: string | undefined = template?.subject;
const customParams: CustomConfigParameters | undefined = template?.customConfigParameters;

getEmailTemplateDefinitions

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja

Respons

Retourneert: GetEmailTemplateDefinitions200Response

Voorbeeld

getEmailTemplateDefinitions Voorbeeld

Copy

const tenantId: string = 'tenant_acme_eu_01';
const templates: GetEmailTemplateDefinitions200Response = await getEmailTemplateDefinitions(tenantId);
console.log('Email template definitions loaded for', tenantId, templates);

getEmailTemplateRenderErrors

Parameters

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

Antwoord

Retourneert: GetEmailTemplateRenderErrors200Response

Voorbeeld

getEmailTemplateRenderErrors Voorbeeld

Copy

(async () => {
  const tenantId: string = 'acme-tenant-42';
  const id: string = 'tmpl_3fa85f64-5717-4562-b3fc-2c963f66afa6';
  const skip: number = 20;
  const result: GetEmailTemplateRenderErrors200Response = await getEmailTemplateRenderErrors(tenantId, id, skip);
  console.log(result);
})();

getEmailTemplates

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
skip	number	Nee

Antwoord

Retourneert: GetEmailTemplates200Response

Voorbeeld

getEmailTemplates Voorbeeld

Copy

async function main(): Promise<void> {
  const tenantId: string = 'tenant_5f3a9c2b';
  const templates: GetEmailTemplates200Response = await getEmailTemplates(tenantId);
  const skip: number = 20;
  const pagedTemplates: GetEmailTemplates200Response = await getEmailTemplates(tenantId, skip);
  console.log(templates, pagedTemplates);
}
main();

renderEmailTemplate

Parameters

Naam	Type	Vereist
tenantId	string	Ja
renderEmailTemplateBody	RenderEmailTemplateBody	Ja
locale	string	Nee

Respons

Retourneert: RenderEmailTemplate200Response

Voorbeeld

Voorbeeld renderEmailTemplate

Copy

const tenantId: string = 'tenant_b6f3c2';
const renderEmailTemplateBody: RenderEmailTemplateBody = {
  templateId: 'comment-notification',
  recipient: { name: 'Ava Thompson', email: 'ava.thompson@publisher.com' },
  context: {
    siteName: 'City Gazette',
    commentText: 'Thanks for the in-depth coverage — very helpful.',
    articleTitle: 'Downtown Redevelopment Plan Advances',
    threadUrl: 'https://citygazette.example/articles/2026/redevelopment#comments'
  }
};
const locale: string = 'en-US';
const result: RenderEmailTemplate200Response = await renderEmailTemplate(tenantId, renderEmailTemplateBody, locale);

updateEmailTemplate

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Ja
updateEmailTemplateBody	UpdateEmailTemplateBody	Ja

Respons

Retourneert: FlagCommentPublic200Response

Voorbeeld

updateEmailTemplate Voorbeeld

Copy

const tenantId: string = "tenant_76a4b2";
const id: string = "template_9f3c1e";
const updateEmailTemplateBody: UpdateEmailTemplateBody = {
  name: "Comment Flag Notification",
  subject: "A comment was flagged on your-site.com",
  bodyHtml: "<p>Admin,</p><p>User {{commenterName}} flagged a comment: “{{commentText}}”</p>",
  isEnabled: true,
  description: "Email sent to moderators when a comment is flagged (optional field included)"
};
const result: FlagCommentPublic200Response = await updateEmailTemplate(tenantId, id, updateEmailTemplateBody);

getEventLog

vereist tenantId urlId userIdWS

Parameters

Naam	Type	Vereist
tenantId	string	Ja
urlId	string	Ja
userIdWS	string	Ja
startTime	number	Ja
endTime	number	Ja

Antwoord

Retourneert: GetEventLog200Response

Voorbeeld

getEventLog Voorbeeld

Copy

const tenantId: string = 'fastcomments-tenant-01';
const urlId: string = 'article-2026-03-25';
const userIdWS: string | undefined = undefined; // optionele upstream-waarde
const startTime: number = Date.parse('2026-03-01T00:00:00Z');
const endTime: number = Date.parse('2026-03-25T23:59:59Z');
const eventLogResponse: GetEventLog200Response = await getEventLog(
  tenantId,
  urlId,
  userIdWS ?? 'ws_user_8b1f',
  startTime,
  endTime
);

getGlobalEventLog

req tenantId urlId userIdWS

Parameters

Naam	Type	Vereist
tenantId	string	Ja
urlId	string	Ja
userIdWS	string	Ja
startTime	number	Ja
endTime	number	Ja

Respons

Geeft terug: GetEventLog200Response

Voorbeeld

getGlobalEventLog Voorbeeld

Copy

const tenantId: string = "tenant-84b2f1";
const urlId: string = "article-6721";
const userIdWS: string = "ws-conn-9a3c";
const startTime: number = Date.now() - 7 * 24 * 60 * 60 * 1000; // 7 dagen geleden
const endTimeOptional: number | undefined = undefined; // optioneel einde van tijdsbestek
const endTime: number = endTimeOptional ?? Date.now();
const eventLog: GetEventLog200Response = await getGlobalEventLog(tenantId, urlId, userIdWS, startTime, endTime);

createFeedPost

Parameters

Naam	Type	Vereist
tenantId	string	Ja
createFeedPostParams	CreateFeedPostParams	Ja
broadcastId	string	Nee
isLive	boolean	Nee
doSpamCheck	boolean	Nee
skipDupCheck	boolean	Nee

Respons

Retourneert: CreateFeedPost200Response

Voorbeeld

createFeedPost Voorbeeld

Copy

const tenantId: string = "tenant_7f3b9a";
const createFeedPostParams: CreateFeedPostParams = {
  title: "Weekly Product Update — March 2026",
  body: "We've shipped performance improvements and bug fixes across the web client. See the release notes for details.",
  authorId: "user_86fa2b",
  allowComments: true,
  media: [
    {
      url: "https://cdn.example.com/images/update-march.png",
      mimeType: "image/png",
      caption: "Performance graph",
      assets: [{ url: "https://cdn.example.com/images/update-march@2x.png", width: 1600, height: 900 }]
    }
  ],
  links: [{ url: "https://www.example.com/release-notes/march-2026", title: "Release notes" }]
};
const broadcastId: string = "broadcast_prod_updates_202603";
const isLive: boolean = false;
const doSpamCheck: boolean = true;
const skipDupCheck: boolean = false;
const result: CreateFeedPost200Response = await createFeedPost(tenantId, createFeedPostParams, broadcastId, isLive, doSpamCheck, skipDupCheck);

createFeedPostPublic

Parameters

Naam	Type	Vereist
tenantId	string	Ja
createFeedPostParams	CreateFeedPostParams	Ja
broadcastId	string	Nee
sso	string	Nee

Antwoord

Retourneert: CreateFeedPostPublic200Response

Voorbeeld

createFeedPostPublic Voorbeeld

Copy

const tenantId: string = "tenant_987654321";
const asset: FeedPostMediaItemAsset = { url: "https://cdn.fastcomments.com/uploads/team-photo.jpg", mimeType: "image/jpeg", sizeBytes: 324512 };
const mediaItem: FeedPostMediaItem = { type: "image", assets: [asset], caption: "Team launch day" };
const link: FeedPostLink = { url: "https://www.example.com/blog/product-update-march-2026", title: "Product update — March 2026" };
const createFeedPostParams: CreateFeedPostParams = {
  title: "Product update — March 2026",
  content: "<p>We shipped performance improvements and two new integrations.</p>",
  media: [mediaItem],
  link,
  visibility: "public",
  tags: ["product","release","march-2026"],
  customConfig: { allowComments: true, requireTOS: false }
};
const broadcastId: string = "broadcast_2026_03_25_live";
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIxMjM0NSIsImlhdCI6MTY5MDI0MDB9.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
const result: CreateFeedPostPublic200Response = await createFeedPostPublic(tenantId, createFeedPostParams, broadcastId, sso);

deleteFeedPostPublic

Parameters

Naam	Type	Vereist
tenantId	string	Ja
postId	string	Ja
broadcastId	string	Nee
sso	string	Nee

Respons

Retourneert: DeleteFeedPostPublic200Response

Voorbeeld

deleteFeedPostPublic Voorbeeld

Copy

const tenantId: string = "tenant_5f8a9b3c";
const postId: string = "post_a1b2c3d4";
const broadcastId: string = "broadcast_2026-03-25T10:00:00Z";
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyMTIzIiwiaWF0IjoxNjE5MjM5MjAwfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
const resultWithOptional: DeleteFeedPostPublic200Response = await deleteFeedPostPublic(tenantId, postId, broadcastId, sso);
const resultRequiredOnly: DeleteFeedPostPublic200Response = await deleteFeedPostPublic(tenantId, postId);

getFeedPosts

req tenantId afterId

Parameters

Naam	Type	Vereist
tenantId	string	Ja
afterId	string	Nee
limit	number	Nee
tags	Array	Nee

Antwoord

Retourneert: GetFeedPosts200Response

Voorbeeld

getFeedPosts Voorbeeld

Copy

const initialPage: GetFeedPosts200Response = await getFeedPosts('tenant_9f1b3d', undefined, 20, ['sports', 'local']);
const nextPage: GetFeedPosts200Response = await getFeedPosts('tenant_9f1b3d', 'post_abc123', 20, ['sports', 'local']);

getFeedPostsPublic

req tenantId afterId

Parameters

Naam	Type	Vereist
tenantId	string	Ja
afterId	string	Nee
limit	number	Nee
tags	Array	Nee
sso	string	Nee
isCrawler	boolean	Nee
includeUserInfo	boolean	Nee

Antwoord

Retourneert: GetFeedPostsPublic200Response

Voorbeeld

getFeedPostsPublic Voorbeeld

Copy

const tenantId: string = 'tenant_acme_01';
const afterId: string = 'fp_20260301_042';
const limit: number = 25;
const tags: Array<string> = ['technology', 'announcement'];
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjoiamRvZSJ9.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
const isCrawler: boolean = false;
const includeUserInfo: boolean = true;
const response: GetFeedPostsPublic200Response = await getFeedPostsPublic(tenantId, afterId, limit, tags, sso, isCrawler, includeUserInfo);

getFeedPostsStats

Parameters

Naam	Type	Vereist
tenantId	string	Ja
postIds	Array	Ja
sso	string	Nee

Respons

Retourneert: GetFeedPostsStats200Response

Voorbeeld

getFeedPostsStats Voorbeeld

Copy

const tenantId: string = 'tenant_9b2f1c4a';
const postIds: Array<string> = [
  '8f14e45f-ea82-4c7a-b6b2-1a2b3c4d5e6f',
  'd0e1f2a3-b4c5-6d7e-8f90-1234567890ab'
];
const sso: string = 'sso_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.signature';
const statsWithoutSSO: GetFeedPostsStats200Response = await getFeedPostsStats(tenantId, postIds);
const statsWithSSO: GetFeedPostsStats200Response = await getFeedPostsStats(tenantId, postIds, sso);

getUserReactsPublic

Parameters

Naam	Type	Vereist
tenantId	string	Ja
postIds	Array	Nee
sso	string	Nee

Respons

Retourneert: GetUserReactsPublic200Response

Voorbeeld

getUserReactsPublic Voorbeeld

Copy

const tenantId: string = "acme-tenant-8a4d2c";
const postIds: string[] = ["post-645a2f", "post-645a30"];
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyXzEyMyIsImlhdCI6MTY2MTYwMDAwMH0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
const result: GetUserReactsPublic200Response = await getUserReactsPublic(tenantId, postIds, sso);

reactFeedPostPublic

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
postId	string	Ja
reactBodyParams	ReactBodyParams	Ja
isUndo	boolean	Nee
broadcastId	string	Nee
sso	string	Nee

Respons

Retourneert: ReactFeedPostPublic200Response

Voorbeeld

reactFeedPostPublic Voorbeeld

Copy

const tenantId: string = 'd290f1ee-6c54-4b01-90e6-d701748f0851';
const postId: string = 'c1a2b3d4-5678-90ab-cdef-1234567890ab';
const reactBodyParams: ReactBodyParams = { reaction: 'like', emoji: '👍', source: 'web' };
const isUndo: boolean = false;
const broadcastId: string = 'broadcast-2026-03-25-001';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyMTIzIn0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
const result: ReactFeedPostPublic200Response = await reactFeedPostPublic(tenantId, postId, reactBodyParams, isUndo, broadcastId, sso);

updateFeedPost

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Ja
feedPost	FeedPost	Ja

Respons

Retourneert: FlagCommentPublic200Response

Voorbeeld

updateFeedPost Voorbeeld

Copy

const tenantId: string = 'acme-global-tenant-42';
const id: string = 'f47ac10b-58cc-4372-a567-0e02b2c3d479';
const asset: FeedPostMediaItemAsset = {
  url: 'https://cdn.acme.com/images/product-launch.jpg',
  mimeType: 'image/jpeg',
  width: 1200,
  height: 630
};
const mediaItem: FeedPostMediaItem = {
  id: 'media-001',
  type: 'image',
  asset
};
const link: FeedPostLink = {
  url: 'https://acme.com/blog/product-launch',
  title: 'Product Launch Details'
};
const feedPost: FeedPost = {
  title: 'Introducing the Q3 Product Suite',
  body: 'We are excited to unveil our new lineup for Q3, focusing on performance and security improvements.',
  media: [mediaItem],     // optionele array opgenomen
  links: [link],          // optionele links opgenomen
  isPublished: true       // optionele publicatievlag hier gebruikt
};
const result: FlagCommentPublic200Response = await updateFeedPost(tenantId, id, feedPost);

updateFeedPostPublic

Parameters

Naam	Type	Vereist
tenantId	string	Ja
postId	string	Ja
updateFeedPostParams	UpdateFeedPostParams	Ja
broadcastId	string	Nee
sso	string	Nee

Respons

Retourneert: CreateFeedPostPublic200Response

Voorbeeld

updateFeedPostPublic Voorbeeld

Copy

const tenantId: string = "tenant_9f4b2";
const postId: string = "post_21a8e";
const updateFeedPostParams: UpdateFeedPostParams = {
  title: "Quarterly product update",
  body: "Major performance improvements and bug fixes deployed today. See release notes and schedule.",
  links: [{ url: "https://status.example.com/release-notes", title: "Release notes" }],
  media: [
    {
      type: "image",
      assets: [{ url: "https://cdn.example.com/updates/q2.png", mimeType: "image/png", width: 1200, height: 628 }]
    }
  ]
};
const broadcastId: string = "broadcast_live_202603";
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature";
const result: CreateFeedPostPublic200Response = await updateFeedPostPublic(tenantId, postId, updateFeedPostParams, broadcastId, sso);

flagCommentPublic

Parameters

Naam	Type	Vereist
tenantId	string	Ja
commentId	string	Ja
isFlagged	boolean	Ja
sso	string	Nee

Respons

Geeft terug: FlagCommentPublic200Response

Voorbeeld

flagCommentPublic Voorbeeld

Copy

const tenantId: string = "tenant_9f8b3c";
const commentId: string = "comment_72a1d4";
const isFlagged: boolean = true;
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI1Njc4OSJ9.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
const result: FlagCommentPublic200Response = await flagCommentPublic(tenantId, commentId, isFlagged, sso);

addHashTag

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Nee
createHashTagBody	CreateHashTagBody	Nee

Respons

Retourneert: AddHashTag200Response

Voorbeeld

addHashTag Voorbeeld

Copy

const tenantId: string = 'tenant_acme_01';
const createHashTagBody: CreateHashTagBody = {
  name: 'feature-request',
  label: 'Feature Request',
  color: '#FF5722',
  enabled: true
};
const response: AddHashTag200Response = await addHashTag(tenantId, createHashTagBody);
const responseWithoutTenant: AddHashTag200Response = await addHashTag(undefined, createHashTagBody);

addHashTagsBulk

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Nee
bulkCreateHashTagsBody	BulkCreateHashTagsBody	Nee

Antwoord

Retourneert: AddHashTagsBulk200Response

Voorbeeld

addHashTagsBulk Voorbeeld

Copy

// Maak tenant-identificator aan (optionele parameter)
const tenantId: string = "tenant_9f8c2b7a";
// Bereid individuele tagitems voor
const tag1: BulkCreateHashTagsBodyTagsInner = {
  name: "product-feedback",
  label: "Product Feedback",
  color: "#1f8a70",
  description: "User suggestions and enhancement requests",
  isActive: true
};
const tag2: BulkCreateHashTagsBodyTagsInner = {
  name: "bug-report",
  label: "Bug Report",
  color: "#d64545",
  description: "User-reported defects and issues",
  isActive: true
};
// Body voor bulkcreatie (optionele parameter)
const bulkCreateHashTagsBody: BulkCreateHashTagsBody = {
  tags: [tag1, tag2]
};
// Roep de globale async-functie aan en wijs het getypeerde resultaat toe
const result: AddHashTagsBulk200Response = await addHashTagsBulk(tenantId, bulkCreateHashTagsBody);

deleteHashTag

Parameters

Naam	Type	Vereist
tag	string	Ja
tenantId	string	Nee
deleteHashTagRequest	DeleteHashTagRequest	Nee

Respons

Retourneert: FlagCommentPublic200Response

Voorbeeld

deleteHashTag Voorbeeld

Copy

const tag: string = "breaking-news";
const tenantId: string = "tenant_12345";
const deleteRequest: DeleteHashTagRequest = { initiatedBy: "moderator@newsorg.com", purgeAllOccurrences: true };
const result: FlagCommentPublic200Response = await deleteHashTag(tag, tenantId, deleteRequest);

getHashTags

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
page	number	Nee

Respons

Retourneert: GetHashTags200Response

Voorbeeld

getHashTags Voorbeeld

Copy

const tenantId: string = 'acme-tenant-42';
const pageNumber: number = 2;
const responseWithPage: GetHashTags200Response = await getHashTags(tenantId, pageNumber);
const responseWithoutPage: GetHashTags200Response = await getHashTags(tenantId);

patchHashTag

Parameters

Naam	Type	Verplicht
tag	string	Ja
tenantId	string	Nee
updateHashTagBody	UpdateHashTagBody	Nee

Response

Retourneert: PatchHashTag200Response

Voorbeeld

patchHashTag Voorbeeld

Copy

const tag: string = "feature-ux-refresh";
const tenantId: string = "tenant_4f92c1";
const updateHashTagBody: UpdateHashTagBody = {
  label: "UX Refresh",
  description: "Track comments related to the 2026 UX redesign",
  isActive: true,
  metadata: { owner: "product-design", rolloutPhase: "phase-2" }
};
const response: PatchHashTag200Response = await patchHashTag(tag, tenantId, updateHashTagBody);

createModerator

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
createModeratorBody	CreateModeratorBody	Ja

Respons

Geeft terug: CreateModerator200Response

Voorbeeld

createModerator Voorbeeld

Copy

const tenantId: string = 'tenant_7d9f2b4a';
const customConfig: CustomConfigParameters = { timezone: 'UTC', moderationQueueEnabled: true };
const createModeratorBody: CreateModeratorBody = {
  email: 'jane.martin@publisher.com',
  displayName: 'Jane Martin',
  roles: ['moderator'],
  sendWelcomeEmail: true,
  customConfig
};
const response: CreateModerator200Response = await createModerator(tenantId, createModeratorBody);

deleteModerator

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
id	string	Ja
sendEmail	string	Nee

Respons

Retourneert: FlagCommentPublic200Response

Voorbeeld

deleteModerator Voorbeeld

Copy

const tenantId: string = 'tenant_9f3b2d4a6c';
const moderatorId: string = 'moderator_84a1b9c2';
const sendEmail: string = 'true';
const result: FlagCommentPublic200Response = await deleteModerator(tenantId, moderatorId, sendEmail);

getModerator

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Ja

Antwoord

Retourneert: GetModerator200Response

Voorbeeld

getModerator Voorbeeld

Copy

const tenantId: string = 'acme-corp-tenant-123';
const id: string = 'mod-987654321';
const moderatorResponse: GetModerator200Response = await getModerator(tenantId, id);

getModerators

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
skip	number	Nee

Respons

Retourneert: GetModerators200Response

Voorbeeld

getModerators Voorbeeld

Copy

const tenantId: string = 'tenant-12345-prod';
const moderatorsPage1: GetModerators200Response = await getModerators(tenantId);
const moderatorsPage2: GetModerators200Response = await getModerators(tenantId, 50);

sendInvite

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Ja
fromName	string	Ja

Antwoord

Retourneert: FlagCommentPublic200Response

Voorbeeld

sendInvite Voorbeeld

Copy

const tenantId: string = 'tenant_acme-42';
const id: string = 'comment_8f3b21a7';
const fromName: string = 'Elena Morales';
const replyToEmail: string | undefined = undefined;
const result: FlagCommentPublic200Response = await sendInvite(tenantId, id, fromName, replyToEmail);

updateModerator

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Ja
updateModeratorBody	UpdateModeratorBody	Ja

Respons

Retourneert: FlagCommentPublic200Response

Voorbeeld

updateModerator Voorbeeld

Copy

const tenantId: string = "acme-enterprises-42";
const id: string = "moderator_517";
const updateModeratorBody: UpdateModeratorBody = {
  displayName: "Sofia Martinez",
  email: "sofia.martinez@acme.com",
  permissions: ["approve_comments", "flag_spam", "suspend_users"],
  active: true,
  avatarUrl: "https://cdn.acme.com/avatars/sofia.jpg" // optioneel veld ter demonstratie
};
const result: FlagCommentPublic200Response = await updateModerator(tenantId, id, updateModeratorBody);

deleteNotificationCount

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Yes
id	string	Yes

Respons

Retourneert: FlagCommentPublic200Response

Voorbeeld

Voorbeeld van deleteNotificationCount

Copy

const tenantSuffix: string | undefined = undefined;
const tenantId: string = tenantSuffix ? `tenant-${tenantSuffix}` : 'tenant-9142a7';
const id: string = '3f9b2a44-1c2e-4d3b-9f6a-8e7c6d5b2a1f';
const result: FlagCommentPublic200Response = await deleteNotificationCount(tenantId, id);
console.log(result);

getCachedNotificationCount

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Ja

Antwoord

Retourneert: GetCachedNotificationCount200Response

Voorbeeld

getCachedNotificationCount Voorbeeld

Copy

const tenantId: string = 'tenant_acme_42';
const id: string = 'user_00012345';
const includeUnreadOnly: boolean | undefined = true; // optionele parametervlag (gedemonstreerd)
const result: GetCachedNotificationCount200Response = await getCachedNotificationCount(tenantId, id);

getNotificationCount

Parameters

Naam	Type	Vereist
tenantId	string	Ja
userId	string	Nee
urlId	string	Nee
fromCommentId	string	Nee
viewed	boolean	Nee
type	string	Nee

Respons

Retourneert: GetNotificationCount200Response

Voorbeeld

getNotificationCount Voorbeeld

Copy

const tenantId: string = 'tenant_abc123';
const userId: string = 'user_987654321';
const urlId: string = 'https://example.com/news/2026/new-features';
const viewed: boolean = false;
const type: string = 'reply';
const notificationCountResponse: GetNotificationCount200Response = await getNotificationCount(tenantId, userId, urlId, undefined, viewed, type);

getNotifications

Parameters

Name	Type	Verplicht
tenantId	string	Ja
userId	string	Nee
urlId	string	Nee
fromCommentId	string	Nee
viewed	boolean	Nee
type	string	Nee
skip	number	Nee

Respons

Retourneert: GetNotifications200Response

Voorbeeld

getNotifications Voorbeeld

Copy

const tenantId: string = "tenant_84b3f2";
const userId: string = "user_1279";
const urlId: string = "https://www.example.com/articles/2026/03/25/new-feature";
const fromCommentId: string = "cmt_5421";
const viewed: boolean = false;
const type: string = "mention";
const skip: number = 0;
const notifications: GetNotifications200Response = await getNotifications(tenantId, userId, urlId, fromCommentId, viewed, type, skip);

updateNotification

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Ja
updateNotificationBody	UpdateNotificationBody	Ja
userId	string	Nee

Respons

Retourneert: FlagCommentPublic200Response

Voorbeeld

updateNotification Voorbeeld

Copy

const tenantId: string = 'tenant_prod_8f4b2c';
const id: string = 'notification_61a2e9';
const userId: string = 'moderator_107';
const updateNotificationBody: UpdateNotificationBody = {
  name: 'Flagged Comment Notification',
  enabled: true,
  channels: ['email', 'inbox'],
  templateId: 'tmpl_mod_alerts_01',
  severity: 'high'
};
const result: FlagCommentPublic200Response = await updateNotification(tenantId, id, updateNotificationBody, userId);

addPage

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
createAPIPageData	CreateAPIPageData	Ja

Antwoord

Retourneert: AddPageAPIResponse

deletePage

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Ja

Antwoord

Retourneert: DeletePageAPIResponse

getPageByURLId

Parameters

Name	Type	Required	Description
tenantId	string	Ja
urlId	string	Ja

Respons

Retourneert: GetPageByURLIdAPIResponse

getPages

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja

Response

Retourneert: GetPagesAPIResponse

patchPage

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Ja
updateAPIPageData	UpdateAPIPageData	Ja

Antwoord

Retourneert: PatchPageAPIResponse

deletePendingWebhookEvent

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
id	string	Ja

Reactie

Retourneert: FlagCommentPublic200Response

Voorbeeld

deletePendingWebhookEvent Voorbeeld

Copy

(async () => {
  const tenantId: string = 'tenant_42f7c9b1';
  const id: string = 'pending_webhook_ev_8f3b9a2d';
  const reason?: string = undefined; // voorbeeld van een optionele parameter (niet vereist door de functie)
  const result: FlagCommentPublic200Response = await deletePendingWebhookEvent(tenantId, id);
  console.log(result);
})();

getPendingWebhookEventCount

Parameters

Naam	Type	Vereist
tenantId	string	Ja
commentId	string	Nee
externalId	string	Nee
eventType	string	Nee
type	string	Nee
domain	string	Nee
attemptCountGT	number	Nee

Response

Retourneert: GetPendingWebhookEventCount200Response

Voorbeeld

getPendingWebhookEventCount Voorbeeld

Copy

const tenantId: string = "tenant_8d3b7a2f";
const commentId: string | undefined = "comment_79a2b";
const eventType: string | undefined = "comment.created";
const domain: string | undefined = "forum.acme-corp.com";
const attemptCountGT: number | undefined = 1;
const result: GetPendingWebhookEventCount200Response = await getPendingWebhookEventCount(
  tenantId,
  commentId,
  undefined,
  eventType,
  undefined,
  domain,
  attemptCountGT
);

getPendingWebhookEvents

Parameters

Naam	Type	Vereist
tenantId	string	Ja
commentId	string	Nee
externalId	string	Nee
eventType	string	Nee
type	string	Nee
domain	string	Nee
attemptCountGT	number	Nee
skip	number	Nee

Respons

Retourneert: GetPendingWebhookEvents200Response

Voorbeeld

getPendingWebhookEvents Voorbeeld

Copy

const tenantId: string = 'tenant_9b3f7c';
const commentId: string | undefined = undefined;
const externalId: string | undefined = 'external-572a';
const eventType: string | undefined = 'comment.updated';
const type: string | undefined = 'outbound';
const domain: string | undefined = 'reviews.example.com';
const attemptCountGT: number | undefined = 1;
const skip: number | undefined = 20;
const result: GetPendingWebhookEvents200Response = await getPendingWebhookEvents(
  tenantId,
  commentId,
  externalId,
  eventType,
  type,
  domain,
  attemptCountGT,
  skip
);

createQuestionConfig

Parameters

Name	Type	Required	Description
tenantId	string	Ja
createQuestionConfigBody	CreateQuestionConfigBody	Ja

Response

Retourneert: CreateQuestionConfig200Response

Voorbeeld

createQuestionConfig Voorbeeld

Copy

const tenantId: string = "tenant_9f8b2c";
const option: QuestionConfigCustomOptionsInner = { id: "opt_yes", label: "Yes, helpful", value: "yes" };
const createQuestionConfigBody: CreateQuestionConfigBody = {
  title: "Article usefulness",
  prompt: "Was this article helpful?",
  type: "singleChoice",
  required: false, // optionele parameter gedemonstreerd
  options: [option],
  saveBehavior: "immediate"
};
const result: CreateQuestionConfig200Response = await createQuestionConfig(tenantId, createQuestionConfigBody);

deleteQuestionConfig

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Ja

Respons

Retourneert: FlagCommentPublic200Response

Voorbeeld

deleteQuestionConfig Voorbeeld

Copy

const tenantId: string = "acme-enterprises-01";
const idOptional: string | undefined = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
const id: string = idOptional ?? "11111111-1111-1111-1111-111111111111";
const response: FlagCommentPublic200Response = await deleteQuestionConfig(tenantId, id);

getQuestionConfig

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Ja

Respons

Retourneert: GetQuestionConfig200Response

Voorbeeld

getQuestionConfig Voorbeeld

Copy

const tenantId: string = 'acme-tenant-92';
const id: string = 'question-2026-07-42';
const response: GetQuestionConfig200Response = await getQuestionConfig(tenantId, id);
function summarize(cfg: GetQuestionConfig200Response, includeDetails?: boolean): string {
  return includeDetails ? 'Question config (detailed)' : 'Question config (summary)';
}
const summary: string = summarize(response);

getQuestionConfigs

Parameters

Name	Type	Required	Description
tenantId	string	Ja
skip	number	Nee

Respons

Retourneert: GetQuestionConfigs200Response

Voorbeeld

getQuestionConfigs Voorbeeld

Copy

const tenantId: string = "tenant_acme_9876";
const configsWithoutSkip: GetQuestionConfigs200Response = await getQuestionConfigs(tenantId);
const configsWithSkip: GetQuestionConfigs200Response = await getQuestionConfigs(tenantId, 20);

updateQuestionConfig

Parameters

Naam	Type	Vereist
tenantId	string	Yes
id	string	Yes
updateQuestionConfigBody	UpdateQuestionConfigBody	Yes

Response

Retourneert: FlagCommentPublic200Response

Voorbeeld

updateQuestionConfig Voorbeeld

Copy

const tenantId: string = 'tenant_42e8b';
const id: string = 'question_9f4a2';
const updateQuestionConfigBody: UpdateQuestionConfigBody = {
  questionText: 'How helpful was this article?',
  description: 'Shown to users below the question (optional)',
  required: true,
  renderingType: 'Likert' as QuestionRenderingType,
  customOptions: [
    { label: 'Very helpful', value: '5' } as QuestionConfigCustomOptionsInner,
    { label: 'Somewhat helpful', value: '3' } as QuestionConfigCustomOptionsInner,
    { label: 'Not helpful', value: '1' } as QuestionConfigCustomOptionsInner
  ],
  whenSave: 'notify' as QuestionWhenSave
};
const result: FlagCommentPublic200Response = await updateQuestionConfig(tenantId, id, updateQuestionConfigBody);

createQuestionResult

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
createQuestionResultBody	CreateQuestionResultBody	Ja

Respons

Retourneert: CreateQuestionResult200Response

Voorbeeld

createQuestionResult Voorbeeld

Copy

const tenantId: string = "tenant-72b1f4";
const meta: MetaItem[] = [{ key: "platform", value: "web" }];
const createQuestionResultBody: CreateQuestionResultBody = {
  questionId: "question-83472",
  commenterId: "user-5521",
  answers: [{ subQuestionId: "sq-1", value: "Yes" }],
  meta, // optionele metadata
  note: "Follow-up requested" // optionele parameter gedemonstreerd
};
const result: CreateQuestionResult200Response = await createQuestionResult(tenantId, createQuestionResultBody);

deleteQuestionResult

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Ja

Respons

Retourneert: FlagCommentPublic200Response

Voorbeeld

Voorbeeld deleteQuestionResult

Copy

const tenantId: string = "org-82479";
const questionId: string = "q-6a3d2e1f";
const includeArchived?: boolean = false; // optionele parameter die een alternatieve doelkeuze demonstreert
const targetId: string = includeArchived ? "q-archived-112233" : questionId;
const result: FlagCommentPublic200Response = await deleteQuestionResult(tenantId, targetId);

getQuestionResult

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Ja

Response

Geeft terug: GetQuestionResult200Response

Voorbeeld

getQuestionResult Voorbeeld

Copy

const post: { title: string; questionId?: string } = { title: 'Product feedback' };
const tenantId: string = 'acme-corp-tenant-01';
const id: string = post.questionId ?? 'q-8f3a7b2c4d9e';
const result: GetQuestionResult200Response = await getQuestionResult(tenantId, id);

getQuestionResults

Parameters

Naam	Type	Vereist
tenantId	string	Ja
urlId	string	Nee
userId	string	Nee
startDate	string	Nee
questionId	string	Nee
questionIds	string	Nee
skip	number	Nee

Respons

Retourneert: GetQuestionResults200Response

Voorbeeld

getQuestionResults Voorbeeld

Copy

const tenantId: string = "tenant_acme_001";
const urlId: string = "articles/product-launch-2026";
const userId: string = "user_2048";
const startDate: string = "2026-03-01T00:00:00Z";
const questionId: string | undefined = undefined;
const questionIds: string | undefined = "q_101,q_102";
const skip: number | undefined = 0;
const result: GetQuestionResults200Response = await getQuestionResults(tenantId, urlId, userId, startDate, questionId, questionIds, skip);

updateQuestionResult

Parameters

Naam	Type	Vereist
tenantId	string	Yes
id	string	Yes
updateQuestionResultBody	UpdateQuestionResultBody	Yes

Respons

Geeft terug: FlagCommentPublic200Response

Voorbeeld

updateQuestionResult Voorbeeld

Copy

const tenantId: string = 'tenant_7f8b3c';
const id: string = 'questionResult_4621';
const updateQuestionResultBody: UpdateQuestionResultBody = {
  questionId: 'q_1024',
  result: 'flagged',
  score: 0.92,
  notes: 'Automated moderation flagged for review',
  meta: [{ key: 'source', value: 'ai-moderator' }] as MetaItem[], // optionele metadata
  status: { code: 'review_pending' } as APIStatus
} as UpdateQuestionResultBody;
const result: FlagCommentPublic200Response = await updateQuestionResult(tenantId, id, updateQuestionResultBody);

aggregateQuestionResults

Parameters

Naam	Type	Vereist
tenantId	string	Ja
questionId	string	Nee
questionIds	Array	Nee
urlId	string	Nee
timeBucket	AggregateTimeBucket	Nee
startDate	Date	Nee
forceRecalculate	boolean	Nee

Respons

Retourneert: AggregateQuestionResults200Response

Voorbeeld

aggregateQuestionResults Voorbeeld

Copy

const tenantId: string = 'tenant_acme_98765';
const questionIds: Array<string> = ['q-102', 'q-103'];
const urlId: string = 'url_55b3';
const timeBucket: AggregateTimeBucket = { unit: 'day', size: 7 };
const startDate: Date = new Date('2026-01-01T00:00:00Z');
const forceRecalculate: boolean = true;
const result: AggregateQuestionResults200Response = await aggregateQuestionResults(
  tenantId,
  undefined, // questionId omitted, using questionIds instead
  questionIds,
  urlId,
  timeBucket,
  startDate,
  forceRecalculate
);

bulkAggregateQuestionResults

Parameters

Naam	Type	Vereist
tenantId	string	Ja
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	Ja
forceRecalculate	boolean	Nee

Respons

Retourneert: BulkAggregateQuestionResults200Response

Voorbeeld

bulkAggregateQuestionResults Voorbeeld

Copy

const tenantId: string = "tenant_live_7c9d";
const bulkAggregateQuestionResultsRequest: BulkAggregateQuestionResultsRequest = {
  items: [
    { questionId: "q_feedback_rating", includeSubQuestions: false, filters: { locale: "en-US" } }
  ],
  timeBuckets: [
    { granularity: "day", startUtc: "2026-03-01T00:00:00Z", endUtc: "2026-03-15T00:00:00Z" }
  ]
};
const forceRecalculate: boolean = true;
const result: BulkAggregateQuestionResults200Response = await bulkAggregateQuestionResults(tenantId, bulkAggregateQuestionResultsRequest, forceRecalculate);

combineCommentsWithQuestionResults

Parameters

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

Respons

Retourneert: CombineCommentsWithQuestionResults200Response

Voorbeeld

combineCommentsWithQuestionResults Voorbeeld

Copy

const tenantId: string = 'tenant_9f3a2';
const questionIds: string[] = ['question-42', 'question-43'];
const urlId: string = 'url_5d7b';
const startDate: Date = new Date('2026-02-01T00: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

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
createAPISSOUserData	CreateAPISSOUserData	Ja

Antwoord

Retourneert: AddSSOUserAPIResponse

deleteSSOUser

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Ja
deleteComments	boolean	Nee
commentDeleteMode	string	Nee

Respons

Geeft terug: DeleteSSOUserAPIResponse

getSSOUserByEmail

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
email	string	Ja

Response

Retourneert: GetSSOUserByEmailAPIResponse

getSSOUserById

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Ja

Respons

Retourneert: GetSSOUserByIdAPIResponse

getSSOUsers

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
skip	number	Nee

Respons

Retourneert: GetSSOUsers200Response

patchSSOUser

Parameters

Name	Type	Required
tenantId	string	Ja
id	string	Ja
updateAPISSOUserData	UpdateAPISSOUserData	Ja
updateComments	boolean	Nee

Response

Retourneert: PatchSSOUserAPIResponse

putSSOUser

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Ja
updateAPISSOUserData	UpdateAPISSOUserData	Ja
updateComments	boolean	Nee

Antwoord

Retourneert: PutSSOUserAPIResponse

createSubscription

Parameters

Name	Type	Required	Description
tenantId	string	Ja
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	Ja

Antwoord

Retourneert: CreateSubscriptionAPIResponse

Voorbeeld

createSubscription Voorbeeld

Copy

const tenantId: string = "acme-corp-123";
const createAPIUserSubscriptionData: CreateAPIUserSubscriptionData = {
  userId: "u_987654",
  planId: "pro_monthly",
  startDate: new Date().toISOString(),
  trialDays: 14, // optionele parameter ter demonstratie
  metadata: { source: "marketing-email" } // optionele parameter ter demonstratie
};
const result: CreateSubscriptionAPIResponse = await createSubscription(tenantId, createAPIUserSubscriptionData);
const subscription: APIUserSubscription = result.subscription;

deleteSubscription

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Ja
userId	string	Nee

Antwoord

Retourneert: DeleteSubscriptionAPIResponse

getSubscriptions

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
userId	string	Nee

Respons

Retourneert: GetSubscriptionsAPIResponse

Voorbeeld

getSubscriptions Voorbeeld

Copy

const tenantId: string = 'tenant_acme_corp_01';
const userId: string = 'user_76a3b9f2';
const subscriptionsForUser: GetSubscriptionsAPIResponse = await getSubscriptions(tenantId, userId);
const subscriptionsForTenant: GetSubscriptionsAPIResponse = await getSubscriptions(tenantId);

updateSubscription

Parameters

Naam	Type	Vereist
tenantId	string	Yes
id	string	Yes
updateAPIUserSubscriptionData	UpdateAPIUserSubscriptionData	Yes
userId	string	No

Respons

Retourneert: UpdateSubscriptionAPIResponse

Voorbeeld

updateSubscription Voorbeeld

Copy

const tenantId: string = 'tenant_9f3b2c';
const subscriptionId: string = 'sub_7641a2b3';
const updateData: UpdateAPIUserSubscriptionData = {
  status: 'active',
  planId: 'pro_annual',
  autoRenew: true,
  renewalDate: '2026-04-15T00:00:00Z',
  metadata: { upgradedBy: 'billing-team' }
};
const userId: string = 'user_215';
const result: UpdateSubscriptionAPIResponse = await updateSubscription(tenantId, subscriptionId, updateData, userId);

getTenantDailyUsages

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
yearNumber	number	Nee
monthNumber	number	Nee
dayNumber	number	Nee
skip	number	Nee

Respons

Retourneert: GetTenantDailyUsages200Response

Voorbeeld

getTenantDailyUsages Voorbeeld

Copy

const tenantId: string = 'tenant_5f4a3b2c-1d6e-4f9a-b9d8-123456789abc';
const yearNumber: number = 2026;
const monthNumber: number = 3;
const dayNumber: number = 24;
const skip: number = 0;
const result: GetTenantDailyUsages200Response = await getTenantDailyUsages(tenantId, yearNumber, monthNumber, dayNumber, skip);

createTenantPackage

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
createTenantPackageBody	CreateTenantPackageBody	Ja

Respons

Geeft terug: CreateTenantPackage200Response

Voorbeeld

createTenantPackage Voorbeeld

Copy

const tenantId: string = 'tenant_acme_001';
const createTenantPackageBody: CreateTenantPackageBody = {
  packageName: 'Standard Moderation',
  description: 'Suitable for small-to-medium sites: basic moderation, spam rules, and analytics',
  maxCommentsPerMinute: 50,
  allowAnonymousComments: false, // optionele parameter opgegeven
  // optionele velden weggelaten: bijv. geavanceerde moderatieregels, aangepaste CSS
  customConfigParameters: {
    enableProfanityFilter: true,
    imageContentProfanityLevel: 'medium' // illustratieve waarde; gebruikt CustomConfigParameters-vorm
  }
};
const response: CreateTenantPackage200Response = await createTenantPackage(tenantId, createTenantPackageBody);
console.log(response);

deleteTenantPackage

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Yes
id	string	Yes

Respons

Retourneert: FlagCommentPublic200Response

Voorbeeld

deleteTenantPackage Voorbeeld

Copy

const tenantId: string = 'tenant_acme_corp_987';
const packageId: string = 'pkg_pro_2026_01';
type DeleteOptions = { force?: boolean; notify?: boolean };
const options: DeleteOptions = { force: true }; // optionele parameters gedemonstreerd
const result: FlagCommentPublic200Response = await deleteTenantPackage(tenantId, packageId);

getTenantPackage

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Ja

Respons

Retourneert: GetTenantPackage200Response

Voorbeeld

getTenantPackage Voorbeeld

Copy

const tenantId: string = 'tenant_7f3b2c8';
const packageId: string = 'pkg_standard_2026';
const requestOptions: { includeConfig?: boolean } = { includeConfig: true };
const packageResponse: GetTenantPackage200Response = await getTenantPackage(tenantId, packageId);

getTenantPackages

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
skip	number	Nee

Antwoord

Retourneert: GetTenantPackages200Response

Voorbeeld

getTenantPackages Voorbeeld

Copy

const tenantId: string = "tenant_7f8e3b4c";
const skip: number = 20;
const packagesDefault: GetTenantPackages200Response = await getTenantPackages(tenantId);
const packagesWithSkip: GetTenantPackages200Response = await getTenantPackages(tenantId, skip);

replaceTenantPackage

Parameters

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

Respons

Retourneert: FlagCommentPublic200Response

Voorbeeld

replaceTenantPackage Voorbeeld

Copy

const tenantId: string = "tenant-9f3c2a";
const id: string = "pkg_4f8b21";
const replaceTenantPackageBody: ReplaceTenantPackageBody = {
  packageName: "Premium Moderation Pack",
  enabled: true,
  apiStatus: { mode: "active" } as APIStatus,
  customConfigParameters: { maxFlagsBeforeReview: 5 } as CustomConfigParameters,
  voteStyle: "thumbs" as VoteStyle,
  tosConfig: { requireAcceptance: true } as TOSConfig
};
const result: FlagCommentPublic200Response = await replaceTenantPackage(tenantId, id, replaceTenantPackageBody);

updateTenantPackage

Parameters

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

Response

Retourneert: FlagCommentPublic200Response

Example

updateTenantPackage Voorbeeld

Copy

const tenantId: string = "tenant_3b7f9d-prod";
const id: string = "pkg_enterprise_2026";
const updateTenantPackageBody: UpdateTenantPackageBody = {
  name: "Enterprise Plus",
  isActive: true,
  // optionele velden opzettelijk weggelaten (bijv. description, limits)
} as UpdateTenantPackageBody;
const result: FlagCommentPublic200Response = await updateTenantPackage(tenantId, id, updateTenantPackageBody);

createTenantUser

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
createTenantUserBody	CreateTenantUserBody	Ja

Respons

Geeft terug: CreateTenantUser200Response

Voorbeeld

createTenantUser Voorbeeld

Copy

const tenantId: string = 'tenant_6f4b2c';
const createTenantUserBody: CreateTenantUserBody = {
  email: 'sara.kim@example.com',
  displayName: 'Sara Kim',
  role: 'moderator',
  notifyOnMentions: true
};
const result: CreateTenantUser200Response = await createTenantUser(tenantId, createTenantUserBody);

deleteTenantUser

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Ja
deleteComments	string	Nee
commentDeleteMode	string	Nee

Antwoord

Retourneert: FlagCommentPublic200Response

Voorbeeld

deleteTenantUser Voorbeeld

Copy

const tenantId: string = '4f3a9b2e-1c6a-4f7b-9e2a-0b8d6f1c2a3e';
const userId: string = '9d2f7b3a-5c4e-48a2-b1f0-6c7d8e9f0a12';
const deleteComments: string = 'true';
const commentDeleteMode: string = 'permanent';
const result: FlagCommentPublic200Response = await deleteTenantUser(tenantId, userId, deleteComments, commentDeleteMode);

getTenantUser

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
id	string	Ja

Respons

Geeft terug: GetTenantUser200Response

Voorbeeld

getTenantUser Voorbeeld

Copy

const tenantId: string = 'tenant_fc5a9b2c';
const userId: string = 'user_0a12b3';
const result: GetTenantUser200Response = await getTenantUser(tenantId, userId);
const user: User | undefined = (result as any).user; // toegang tot payload
const userEmail: string | undefined = user?.email;
console.log('Fetched user email:', userEmail);

getTenantUsers

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
skip	number	Nee

Response

Retourneert: GetTenantUsers200Response

Example

getTenantUsers Voorbeeld

Copy

const tenantId: string = 'tenant_prod_8a3f2c';
const skip: number = 50;
const usersWithSkip: GetTenantUsers200Response = await getTenantUsers(tenantId, skip);
const usersNoSkip: GetTenantUsers200Response = await getTenantUsers(tenantId);

replaceTenantUser

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Ja
replaceTenantUserBody	ReplaceTenantUserBody	Ja
updateComments	string	Nee

Respons

Retourneert: FlagCommentPublic200Response

Voorbeeld

replaceTenantUser Voorbeeld

Copy

const tenantId: string = 'tenant_9d8f4b2c';
const id: string = 'user_f47ac10b';
const replaceTenantUserBody: ReplaceTenantUserBody = {
  externalId: 'ext-5234',
  email: 'jane.doe@acme.com',
  displayName: 'Jane Doe',
  roles: ['moderator'],
  metadata: { department: 'product', region: 'us-east-1' }
};
const updateComments: string = 'propagate-display-name-to-comments';
const result: FlagCommentPublic200Response = await replaceTenantUser(tenantId, id, replaceTenantUserBody, updateComments);

sendLoginLink

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Ja
redirectURL	string	Nee

Response

Retourneert: FlagCommentPublic200Response

Voorbeeld

sendLoginLink Voorbeeld

Copy

const tenantId: string = "tenant_12a9f3b7";
const id: string = "user_84b2c7d1";
const redirectURL: string = "https://app.mycompany.com/welcome?ref=login_email";
const resultWithoutRedirect: FlagCommentPublic200Response = await sendLoginLink(tenantId, id);
const resultWithRedirect: FlagCommentPublic200Response = await sendLoginLink(tenantId, id, redirectURL);

updateTenantUser

Parameters

Name	Type	Required
tenantId	string	Ja
id	string	Ja
updateTenantUserBody	UpdateTenantUserBody	Ja
updateComments	string	Nee

Respons

Geeft terug: FlagCommentPublic200Response

Voorbeeld

updateTenantUser Voorbeeld

Copy

const tenantId: string = "tenant_8f3b2a9d";
const id: string = "user_52c9f1ab";
const updateTenantUserBody: UpdateTenantUserBody = {
  email: "jane.doe@example.com",
  displayName: "Jane Doe",
  roles: ["moderator"],
  isActive: true,
  metadata: { signupSource: "sso", locale: "en-US" }
};
const updateComments: string = "Promoted to moderator and updated display name";
const result: FlagCommentPublic200Response = await updateTenantUser(tenantId, id, updateTenantUserBody, updateComments);

createTenant

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
createTenantBody	CreateTenantBody	Ja

Respons

Geeft terug: CreateTenant200Response

Voorbeeld

createTenant Voorbeeld

Copy

const tenantId: string = "acme-corp-001";
const createTenantBody: CreateTenantBody = {
  name: "Acme Corporation",
  domain: "comments.acme.com",
  adminContact: { name: "Jane Doe", email: "jane.doe@acme.com" },
  billingInfo: { planId: "pro-monthly", billingContactEmail: "billing@acme.com" },
  importedSite: { siteId: "site-123", siteName: "Acme Blog" } // optionele geïmporteerde site
};
const result: CreateTenant200Response = await createTenant(tenantId, createTenantBody);

deleteTenant

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Ja
sure	string	Nee

Respons

Retourneert: FlagCommentPublic200Response

Voorbeeld

deleteTenant Voorbeeld

Copy

const tenantId: string = "tenant_7f3d2c";
const id: string = "flag_8392b1a7";
const sure: string = "confirmed";
const responseWithoutSure: FlagCommentPublic200Response = await deleteTenant(tenantId, id);
const responseWithSure: FlagCommentPublic200Response = await deleteTenant(tenantId, id, sure);

getTenant

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Ja

Respons

Retourneert: GetTenant200Response

Voorbeeld

getTenant Voorbeeld

Copy

const tenantId: string = "tenant_9f4b2c1a";
const idOverride: string | undefined = undefined; // optionele override, indien beschikbaar
const id: string = idOverride ?? "site_3e7a6b2f";
const response: GetTenant200Response = await getTenant(tenantId, id);
console.log(response);

getTenants

Parameters

Naam	Type	Vereist
tenantId	string	Ja
meta	string	Nee
skip	number	Nee

Respons

Retourneert: GetTenants200Response

Voorbeeld

getTenants Voorbeeld

Copy

const tenantId: string = 'tenant_8421e7';
const meta: string = 'include=domains,billing,customConfig';
const skip: number = 20;
const tenantsBasic: GetTenants200Response = await getTenants(tenantId);
const tenantsWithOptions: GetTenants200Response = await getTenants(tenantId, meta, skip);

updateTenant

Parameters

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

Antwoord

Retourneert: FlagCommentPublic200Response

Voorbeeld

updateTenant Voorbeeld

Copy

const tenantId: string = "tenant_4821";
const id: string = "flag_7b9e";
const billingInfo: BillingInfo | undefined = undefined; // optioneel, weglaten om huidige facturering te behouden
const updateTenantBody: UpdateTenantBody = {
  name: "Acme News Comments",
  defaultDomain: "comments.acme.com",
  ...(billingInfo ? { billingInfo } : {})
};
const result: FlagCommentPublic200Response = await updateTenant(tenantId, id, updateTenantBody);

changeTicketState

Parameters

Naam	Type	Vereist
tenantId	string	Ja
userId	string	Ja
id	string	Ja
changeTicketStateBody	ChangeTicketStateBody	Ja

Respons

Retourneert: ChangeTicketState200Response

Voorbeeld

changeTicketState Voorbeeld

Copy

const tenantId: string = 'tenant_82f9b3';
const userId: string = 'user_9472';
const id: string = 'ticket_550e8400-e29b-41d4-a716-446655440000';
const changeTicketStateBody: ChangeTicketStateBody = {
  state: 'resolved',
  comment: 'Confirmed fix deployed to production; closing ticket.',
  notifySubscribers: true
};
const result: ChangeTicketState200Response = await changeTicketState(tenantId, userId, id, changeTicketStateBody);

createTicket

Parameters

Name	Type	Vereist
tenantId	string	Ja
userId	string	Ja
createTicketBody	CreateTicketBody	Ja

Respons

Geeft terug: CreateTicket200Response

Voorbeeld

createTicket Voorbeeld

Copy

const tenantId: string = "acme-corp-001";
const userId: string = "user_72b9f4";
const createTicketBody: CreateTicketBody = {
  subject: "Subscription renewal failed for card on file",
  description: "Customer's card was declined by the payment processor during automatic renewal. Transaction ID: txn_9a8b7c. Please review gateway logs and retry.",
  priority: "high", // optioneel veld ter demonstratie
  contactEmail: "billing@acme-corp.com", // optionele contactgegevens
  relatedUrl: "https://acme-corp.com/account/billing"
};
const ticketResponse: CreateTicket200Response = await createTicket(tenantId, userId, createTicketBody);

getTicket

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Ja
userId	string	Nee

Respons

Retourneert: GetTicket200Response

Voorbeeld

getTicket Voorbeeld

Copy

const tenantId: string = 'acme-corp-tenant-01';
const ticketId: string = 'tkt-20260325-42';
const userId: string = 'user-8452';
const ticketResponseWithUser: GetTicket200Response = await getTicket(tenantId, ticketId, userId);
const ticketResponseWithoutUser: GetTicket200Response = await getTicket(tenantId, ticketId);

getTickets

Parameters

Naam	Type	Vereist
tenantId	string	Ja
userId	string	Nee
state	number	Nee
skip	number	Nee
limit	number	Nee

Antwoord

Geeft terug: GetTickets200Response

Voorbeeld

getTickets Voorbeeld

Copy

const tenantId: string = "tenant_92f3b4c1";
const userId: string = "user_742a9f3e";
const state: number = 1;
const skip: number = 0;
const limit: number = 25;
const ticketsFull: GetTickets200Response = await getTickets(tenantId, userId, state, skip, limit);
const ticketsMinimal: GetTickets200Response = await getTickets("tenant_92f3b4c1");

uploadImage

Een afbeelding uploaden en formaat wijzigen

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
file	Blob	Ja
sizePreset	SizePreset	Nee
urlId	string	Nee

Respons

Geeft terug: UploadImageResponse

getUserBadgeProgressById

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Ja

Antwoord

Retourneert: GetUserBadgeProgressById200Response

Voorbeeld

getUserBadgeProgressById Voorbeeld

Copy

const optionalTenantSuffix: string | undefined = undefined;
const tenantId: string = `5f8d0d55-1234-4ab1-9e2a-3f2b5c6d7e8f${optionalTenantSuffix ?? ''}`;
const id: string = '3a2b1c4d-5678-4ef0-9abc-def123456789';
const result: GetUserBadgeProgressById200Response = await getUserBadgeProgressById(tenantId, id);

getUserBadgeProgressByUserId

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
userId	string	Ja

Respons

Retourneert: GetUserBadgeProgressById200Response

Voorbeeld

getUserBadgeProgressByUserId Voorbeeld

Copy

const tenantId: string = 'tenant_7f9c2d3b';
const maybeUserId: string | undefined = 'user_4b8e1f9a'; // optionele bron (kan undefined zijn)
const userId: string = maybeUserId ?? 'user_fallback0001';
const result: GetUserBadgeProgressById200Response = await getUserBadgeProgressByUserId(tenantId, userId);
console.log(result);

getUserBadgeProgressList

Parameters

Naam	Type	Vereist
tenantId	string	Ja
userId	string	Nee
limit	number	Nee
skip	number	Nee

Antwoord

Retourneert: GetUserBadgeProgressList200Response

Voorbeeld

getUserBadgeProgressList Voorbeeld

Copy

(async () => {
  const tenantId: string = 'tenant_4f8c2b9d';
  const userId: string = 'user_9a7e215c';
  const limit: number = 25;
  const skip: number = 0;
  const resultMinimal: GetUserBadgeProgressList200Response = await getUserBadgeProgressList(tenantId);
  const resultFull: GetUserBadgeProgressList200Response = await getUserBadgeProgressList(tenantId, userId, limit, skip);
  console.log(resultMinimal, resultFull);
})();

createUserBadge

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
createUserBadgeParams	CreateUserBadgeParams	Ja

Respons

Retourneert: CreateUserBadge200Response

Voorbeeld

createUserBadge Voorbeeld

Copy

const tenantId: string = 'tenant_84f3b2';
const createUserBadgeParams: CreateUserBadgeParams = {
  name: 'Top Contributor',
  slug: 'top-contributor',
  imageUrl: 'https://assets.fastcomments.com/badges/top-contributor.png',
  description: 'Awarded for 100 helpful comments',
  active: true,
  criteria: { commentsCount: 100 }, // optionele criteria
  displayOrder: 10,
  metadata: { featured: true } // optionele metadata
};
const result: CreateUserBadge200Response = await createUserBadge(tenantId, createUserBadgeParams);
console.log(result);

deleteUserBadge

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Ja

Respons

Retourneert: UpdateUserBadge200Response

Voorbeeld

deleteUserBadge Voorbeeld

Copy

type DeleteOptions = { notifyModerators?: boolean };
const tenantId: string = 'tenant_8a3f21';
const id: string = 'badge_71f2b';
const options: DeleteOptions = { notifyModerators: true };
const result: UpdateUserBadge200Response = await deleteUserBadge(tenantId, id);

getUserBadge

Parameters

Name	Type	Required	Description
tenantId	string	Ja
id	string	Ja

Respons

Retourneert: GetUserBadge200Response

Voorbeeld

getUserBadge Voorbeeld

Copy

const tenantId: string = "tenant_acme_01";
const id: string = "badge_8c7d2f";
const response: GetUserBadge200Response = await getUserBadge(tenantId, id);

getUserBadges

Parameters

Naam	Type	Vereist
tenantId	string	Ja
userId	string	Nee
badgeId	string	Nee
type	number	Nee
displayedOnComments	boolean	Nee
limit	number	Nee
skip	number	Nee

Antwoord

Retourneert: GetUserBadges200Response

Voorbeeld

getUserBadges Voorbeeld

Copy

const tenantId: string = 'tenant_acme_01';
const userId: string = 'user_5f4d3c2a';
const badgeId: string = 'badge_top_contributor';
const type: number = 1;
const displayedOnComments: boolean = true;
const limit: number = 50;
const skip: number = 0;
const result: GetUserBadges200Response = await getUserBadges(tenantId, userId, badgeId, type, displayedOnComments, limit, skip);

updateUserBadge

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Ja
updateUserBadgeParams	UpdateUserBadgeParams	Ja

Respons

Retourneert: UpdateUserBadge200Response

Voorbeeld

updateUserBadge Voorbeeld

Copy

(async () => {
  const tenantId: string = 'tenant_acme_987';
  const id: string = 'badge_top_contributor_42';
  const updateUserBadgeParams: UpdateUserBadgeParams = {
    title: 'Top Contributor',
    description: 'Awarded for reaching 100 high-quality comments',
    color: '#FFD700',
    iconUrl: 'https://cdn.acme.com/badges/top-contributor.svg',
    active: true,
    notifyUsers: true
  } as UpdateUserBadgeParams;
  const result: UpdateUserBadge200Response = await updateUserBadge(tenantId, id, updateUserBadgeParams);
  console.log(result);
})();

getUserNotificationCount

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
sso	string	Nee

Respons

Retourneert: GetUserNotificationCount200Response

Voorbeeld

getUserNotificationCount Voorbeeld

Copy

(async () => {
  const tenantId: string = '9f1e2d3c-4b5a-6d7e-8f90-123456789abc';
  const ssoToken: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI0MjMifQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
  const resultWithSSO: GetUserNotificationCount200Response = await getUserNotificationCount(tenantId, ssoToken);
  const resultWithoutSSO: GetUserNotificationCount200Response = await getUserNotificationCount(tenantId);
  console.log(resultWithSSO, resultWithoutSSO);
})();

getUserNotifications

Parameters

Naam	Type	Vereist
tenantId	string	Ja
pageSize	number	Nee
afterId	string	Nee
includeContext	boolean	Nee
afterCreatedAt	number	Nee
unreadOnly	boolean	Nee
dmOnly	boolean	Nee
noDm	boolean	Nee
includeTranslations	boolean	Nee
sso	string	Nee

Respons

Retourneert: GetUserNotifications200Response

Voorbeeld

getUserNotifications Voorbeeld

Copy

const tenantId: string = 'tenant_7f3b1c';
const pageSize: number = 25;
const afterId: string = 'notif_b2f9e4';
const includeContext: boolean = true;
const afterCreatedAt: number = Date.now() - 24 * 60 * 60 * 1000;
const unreadOnly: boolean = true;
const dmOnly: boolean = false;
const noDm: boolean = false;
const includeTranslations: boolean = true;
const sso: string = 'sso_tok_user_9f8d7c';
const response: GetUserNotifications200Response = await getUserNotifications(
  tenantId,
  pageSize,
  afterId,
  includeContext,
  afterCreatedAt,
  unreadOnly,
  dmOnly,
  noDm,
  includeTranslations,
  sso
);

resetUserNotificationCount

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
sso	string	Nee

Respons

Retourneert: ResetUserNotifications200Response

Voorbeeld

resetUserNotificationCount Voorbeeld

Copy

(async () => {
  const tenantId: string = "tenant_9f3b2c4a";
  const ssoToken: string | undefined = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9._sample_payload_.signature";
  const responseWithSSO: ResetUserNotifications200Response = await resetUserNotificationCount(tenantId, ssoToken);
  const responseWithoutSSO: ResetUserNotifications200Response = await resetUserNotificationCount(tenantId);
  console.log(responseWithSSO, responseWithoutSSO);
})();

resetUserNotifications

Parameters

Naam	Type	Vereist
tenantId	string	Ja
afterId	string	Nee
afterCreatedAt	number	Nee
unreadOnly	boolean	Nee
dmOnly	boolean	Nee
noDm	boolean	Nee
sso	string	Nee

Respons

Retourneert: ResetUserNotifications200Response

Voorbeeld

resetUserNotifications Voorbeeld

Copy

const tenantId: string = "tenant_prod_4a9f12";
const afterId: string = "notification_87213";
const afterCreatedAt: number = Math.floor(Date.now() / 1000) - 3600;
const unreadOnly: boolean = true;
const dmOnly: boolean = false;
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.payload";
const result: ResetUserNotifications200Response = await resetUserNotifications(tenantId, afterId, afterCreatedAt, unreadOnly, dmOnly, undefined, sso);

updateUserNotificationCommentSubscriptionStatus

Schakel meldingen in of uit voor een specifieke opmerking.

Parameters

Name	Type	Required
tenantId	string	Ja
notificationId	string	Ja
optedInOrOut	UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum	Ja
commentId	string	Ja
sso	string	Nee

Antwoord

Retourneert: UpdateUserNotificationStatus200Response

Voorbeeld

updateUserNotificationCommentSubscriptionStatus Voorbeeld

Copy

const tenantId: string = 'acme-tenant-001';
const notificationId: string = 'notif-2026-03-25-01';
const commentId: string = 'cmt-8f3a2b';
const optedInOrOut: UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum = UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum.OptIn;
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sso-payload.signature';
const result: UpdateUserNotificationStatus200Response = await updateUserNotificationCommentSubscriptionStatus(tenantId, notificationId, optedInOrOut, commentId, sso);

updateUserNotificationPageSubscriptionStatus

Schakel meldingen voor een pagina in of uit. Wanneer gebruikers zich op een pagina hebben geabonneerd, worden meldingen aangemaakt voor nieuwe root-opmerkingen, en ook

Parameters

Naam	Type	Vereist
tenantId	string	Ja
urlId	string	Ja
url	string	Ja
pageTitle	string	Ja
subscribedOrUnsubscribed	UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum	Ja
sso	string	Nee

Respons

Retourneert: UpdateUserNotificationStatus200Response

Voorbeeld

updateUserNotificationPageSubscriptionStatus Voorbeeld

Copy

const tenantId: string = 'acme-tenant-42';
const urlId: string = 'blog-launch-2026';
const url: string = 'https://acme.example.com/blog/launch-march-2026';
const pageTitle: string = 'Acme Product Launch — March 2026';
const subscribedOrUnsubscribed: UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum = UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum.Subscribed;
const sso: string = 'sso_jwt_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
const response: UpdateUserNotificationStatus200Response = await updateUserNotificationPageSubscriptionStatus(tenantId, urlId, url, pageTitle, subscribedOrUnsubscribed, sso);

updateUserNotificationStatus

Parameters

Naam	Type	Vereist
tenantId	string	Ja
notificationId	string	Ja
newStatus	UpdateUserNotificationStatusNewStatusEnum	Ja
sso	string	Nee

Respons

Retourneert: UpdateUserNotificationStatus200Response

Voorbeeld

updateUserNotificationStatus Voorbeeld

Copy

const tenantId: string = 'tenant_84a2c3';
const notificationId: string = 'notif_20260325_01';
const newStatus: UpdateUserNotificationStatusNewStatusEnum = UpdateUserNotificationStatusNewStatusEnum.Read;
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sso_signature_example';
const result: UpdateUserNotificationStatus200Response = await updateUserNotificationStatus(tenantId, notificationId, newStatus, sso);

getUserPresenceStatuses

Parameters

Naam	Type	Vereist
tenantId	string	Ja
urlIdWS	string	Ja
userIds	string	Ja

Respons

Retourneert: GetUserPresenceStatuses200Response

Voorbeeld

getUserPresenceStatuses Voorbeeld

Copy

const tenantId: string = 'tenant_7f3a2b';
const urlIdWS: string = 'articles/2026/03/25/fastcomments-integration';
const maybeUserIds: string | undefined = 'user_123,user_456'; // optionele bron
const userIds: string = maybeUserIds ?? 'user_123';
const presence: GetUserPresenceStatuses200Response = await getUserPresenceStatuses(tenantId, urlIdWS, userIds);

searchUsers

Parameters

Naam	Type	Vereist
tenantId	string	Ja
urlId	string	Ja
usernameStartsWith	string	Nee
mentionGroupIds	Array	Nee
sso	string	Nee
searchSection	SearchUsersSearchSectionEnum	Nee

Respons

Geeft terug: SearchUsers200Response

Voorbeeld

searchUsers Voorbeeld

Copy

const tenantId: string = 'tenant_8392';
const urlId: string = 'articles/2026/03/25/fastcomments-release';
const usernameStartsWith: string = 'jo';
const mentionGroupIds: Array<string> = ['editors', 'senior-writers'];
const sso: string = 'sso_jwt_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
const searchSection: SearchUsersSearchSectionEnum = SearchUsersSearchSectionEnum.ALL;
const result: SearchUsers200Response = await searchUsers(tenantId, urlId, usernameStartsWith, mentionGroupIds, sso, searchSection);

getUser

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Ja

Respons

Retourneert: GetUser200Response

Voorbeeld

getUser Voorbeeld

Copy

const tenantId: string = 'tenant_7b3f42';
const id: string = 'user_9c4d2a';
const userResponse: GetUser200Response = await getUser(tenantId, id);
console.log(userResponse);

createVote

Parameters

Naam	Type	Vereist
tenantId	string	Ja
commentId	string	Ja
direction	CreateVoteDirectionEnum	Ja
userId	string	Nee
anonUserId	string	Nee

Antwoord

Retourneert: VoteComment200Response

Voorbeeld

createVote Voorbeeld

Copy

const tenantId: string = 'tenant_9f8b6a';
const commentId: string = 'comment_3b7d2e';
const direction: CreateVoteDirectionEnum = CreateVoteDirectionEnum.Up;
const anonUserId: string = 'anon_4c2a1f';
const voteResult: VoteComment200Response = await createVote(tenantId, commentId, direction, undefined, anonUserId);

deleteVote

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Ja
editKey	string	Nee

Response

Retourneert: DeleteCommentVote200Response

Voorbeeld

deleteVote Voorbeeld

Copy

const tenantId: string = "tenant_7c3f2b4a";
const voteId: string = "vote_4f8d9a11";
const editKey: string = "edit_2b9f8c";
const resultWithoutKey: DeleteCommentVote200Response = await deleteVote(tenantId, voteId);
const resultWithKey: DeleteCommentVote200Response = await deleteVote(tenantId, voteId, editKey);

getVotes

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Yes
urlId	string	Yes

Antwoord

Retourneert: GetVotes200Response

Voorbeeld

getVotes Voorbeeld

Copy

const tenantId: string = 'acme-corp-8f3b';
const refCampaign: string | undefined = 'newsletter-march2026'; // optionele queryparameter
const urlId: string = `https://www.example.com/articles/2026/03/25/fastcomments-integration${refCampaign ? `?ref=${refCampaign}` : ''}`;
const votes: GetVotes200Response = await getVotes(tenantId, urlId);

getVotesForUser

Parameters

Name	Type	Required
tenantId	string	Ja
urlId	string	Ja
userId	string	Nee
anonUserId	string	Nee

Respons

Retourneert: GetVotesForUser200Response

Voorbeeld

getVotesForUser Voorbeeld

Copy

(async (): Promise<void> => {
  const tenantId: string = "local-news-ny";
  const urlId: string = "articles/2026-03-25/ev-infrastructure-update";
  const userId: string = "user_78b6f3d9";
  const anonUserId: string = "anon_9c3f7a1b";
  const result: GetVotesForUser200Response = await getVotesForUser(tenantId, urlId, userId, anonUserId);
  console.log(result);
})();

Hulp nodig?

Als u problemen ondervindt of vragen heeft over de JavaScript/TypeScript SDK, kunt u:

Bijdragen

Bijdragen zijn welkom! Bezoek de GitHub-repository voor richtlijnen voor bijdragen.

Taal 🇳🇱 Nederlands

Aan de slag

API-referentie

Documentatie

Gebruik

Aggregatie

Auditlogs

Blokkeren van opmerking

Controleren op geblokkeerde opmerkingen

Reacties

Domeinconfiguraties

E-mailsjablonen

Gebeurtenislogboek

Feed-berichten

Opmerking markeren

Hashtags

Moderatoren

Aantal meldingen

Meldingen

Pagina's

Wachtende webhook-gebeurtenissen

Vraagconfiguraties

Vraagresultaten

Aggregatie van vraagresultaten

SSO-gebruikers

Abonnementen

Dagelijks gebruik per tenant

Tenantpakketten

Tenantgebruikers

Tenants

Tickets

Afbeelding uploaden

Voortgang gebruikersbadge

Gebruikersbadges

Gebruikersmeldingen

Aanwezigheidsstatussen

Gebruikers zoeken

Gebruikers

Stemmen

FastComments JavaScript/TypeScript SDK

Repository

Installatie

API-documentatie

Volledige API-referentie: docs/api/README.md

Browser- vs Server-compatibiliteit

Gebruik

Browsergebruik (Client-Side)

Servergebruik (Node.js)

Alleen types importeren

Gebruik van individuele API-klassen

Browseromgeving

Serveromgeving

Openbare vs beveiligde API's

Voorbeeld: Public API gebruiken (browser-veilig)

Voorbeeld: Default API gebruiken (alleen serverzijde)

SSO (Single Sign-On) integratie

Eenvoudige SSO (Alleen serverzijde)

Beveiligde SSO (Server-side, aanbevolen)

SSO gebruiken vanuit de browser (met door de server gegenereerd token)

SSO met het aanmaken van een reactie

Veelvoorkomende gebruiksgevallen

Reacties ophalen voor een pagina

Een reactie aanmaken

Stemmen op een reactie

Gebruikersbeheer (vereist API-sleutel)

Live-evenementen (Realtime-updates)

Paginaniveau-evenementen

Abonneer op gebruikersgebeurtenissen

Het verkrijgen van userIdWS

Broadcast-ID's

Foutafhandeling

aggregate

Parameters

Antwoord

getAuditLogs

Parameters

Antwoord

Voorbeeld

blockFromCommentPublic

Parameters