
Sprache 🇩🇪 Deutsch
Dokumentation
Aggregation
Auditprotokolle
Authentifizierung
Blockieren aus Kommentar
Blockierte Kommentare prüfen
Kommentare
Kommentare für Benutzer
Domain-Konfigurationen
E-Mail-Vorlagen
Ereignisprotokoll
Feed-Beiträge
Kommentar melden
GIFs
Hashtags
Moderation
Moderatoren
Benachrichtigungszähler
Benachrichtigungen
Seitenreaktionen
Seiten
Ausstehende Webhook-Ereignisse
Fragenkonfigurationen
Fragergebnisse
Aggregation von Fragergebnissen
SSO-Benutzer
Abonnements
Tägliche Mandantennutzung
Mandantenpakete
Mandantenbenutzer
Mandanten
Tickets
Übersetzungen
Bild hochladen
Fortschritt von Benutzerabzeichen
Benutzerabzeichen
Benutzerbenachrichtigungen
Anwesenheitsstatus der Benutzer
Benutzersuche
Benutzer
Abstimmungen
FastComments Dart SDK
Dies ist das offizielle Dart‑SDK für FastComments.
Verwalten Sie Kommentare, Benutzer, SSO und Moderation aus Ihren Dart‑ und Flutter‑Anwendungen.
Repository
Layout 
fastcomments-dart/
client/ generated dart client (do not edit by hand)
sso/ hand-written SSO token helpers
openapi.json committed copy of the spec used for generation
config.json openapi-generator config
update.py regenerate the client from the spec
Verwendung 
dependencies:
fastcomments_dart: ^3.0.0
SSO‑Hilfsfunktionen sind im Paket (package:fastcomments_dart/sso/...) enthalten.
Der Client stellt drei API‑Klassen bereit:
DefaultApi– API‑Key‑authentifizierte Methoden für die serverseitige Nutzung.PublicApi– öffentliche Methoden, die keinen API‑Schlüssel benötigen und sicher für Browser‑ und Mobil‑Clients sind.ModerationApi– ein umfangreiches Set aus Live‑ und schnellen Moderations‑APIs. JedeModerationApi‑Methode nimmt einensso‑Parameter entgegen und kann sich über SSO oder ein FastComments.com‑Session‑Cookie authentifizieren.
import 'package:fastcomments_dart/api.dart';
final api = PublicApi(ApiClient(basePath: 'https://fastcomments.com'));
final comments = await api.getCommentsPublic('YOUR_TENANT_ID', 'YOUR_URL_ID');import 'package:fastcomments_dart/api.dart';
final publicApi = PublicApi(ApiClient(basePath: 'https://fastcomments.com'));
final feedPosts = await publicApi.getFeedPostsPublic('YOUR_TENANT_ID');import 'package:fastcomments_dart/api.dart';
final moderation = ModerationApi(ApiClient(basePath: 'https://fastcomments.com'));
final result = await moderation.getApiComments(
GetApiCommentsOptions(sso: 'SSO_TOKEN'),
);
SSO 
import 'package:fastcomments_dart/sso/fastcomments_sso.dart';
import 'package:fastcomments_dart/sso/secure_sso_user_data.dart';
final sso = FastCommentsSSO.secure(
apiKey: 'YOUR_API_SECRET',
user: SecureSSOUserData(
id: 'user-123',
email: 'jane@example.com',
username: 'jane',
avatar: 'https://example.com/jane.png',
),
);
final token = sso.prepareToSend();
Aggregieren 
Aggregiert Dokumente, indem sie (falls groupBy angegeben ist) gruppiert und mehrere Vorgänge angewendet werden.
Verschiedene Vorgänge (z. B. sum, countDistinct, avg usw.) werden unterstützt.
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| parentTenantId | string | query | Nein | |
| includeStats | boolean | query | Nein |
Antwort
Rückgabe: AggregateResponse
Beispiel

Auditprotokolle abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| limit | number | query | Nein | |
| skip | number | query | Nein | |
| order | string | query | Nein | |
| after | number | query | Nein | |
| before | number | query | Nein |
Antwort
Rückgabe: GetAuditLogsResponse
Beispiel

Öffentlichen Logout 
Response
Returns: APIEmptyResponse
Example

Öffentliches Blockieren aus Kommentar 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nein |
Antwort
Rückgabe: BlockSuccess
Beispiel

Öffentliches Blockieren aufheben Kommentar 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nein |
Antwort
Rückgabe: UnblockSuccess
Beispiel

Überprüfte Kommentare auf Blockierung 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentIds | string | query | Ja | Eine kommagetrennte Liste von Kommentar-IDs. |
| sso | string | query | Nein |
Antwort
Rückgabe: CheckBlockedCommentsResponse
Beispiel

Benutzer aus Kommentar blockieren 
Parameters
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Response
Rückgabe: BlockSuccess
Beispiel

Öffentlichen Kommentar erstellen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| broadcastId | string | query | Ja | |
| sessionId | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Returns: SaveCommentsResponseWithPresence
Beispiel

Kommentar löschen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| contextUserId | string | query | Nein | |
| isLive | boolean | query | Nein |
Antwort
Rückgabe: DeleteCommentResult
Beispiel

Öffentlichen Kommentar löschen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| editKey | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Rückgabe: PublicAPIDeleteCommentResponse
Beispiel

Kommentarbewertung löschen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| voteId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Antwort
Rückgabe: VoteDeleteResponse
Beispiel

Kommentar melden 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nein | |
| anonUserId | string | query | Nein |
Antwort
Rückgabe: FlagCommentResponse
Beispiel

Kommentar abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Rückgabe: APIGetCommentResponse
Beispiel

Kommentare abrufen 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| page | integer | query | Nein | |
| limit | integer | query | Nein | |
| skip | integer | query | Nein | |
| asTree | boolean | query | Nein | |
| skipChildren | integer | query | Nein | |
| limitChildren | integer | query | Nein | |
| maxTreeDepth | integer | query | Nein | |
| urlId | string | query | Nein | |
| userId | string | query | Nein | |
| anonUserId | string | query | Nein | |
| contextUserId | string | query | Nein | |
| hashTag | string | query | Nein | |
| parentId | string | query | Nein | |
| direction | string | query | Nein | |
| fromDate | integer | query | Nein | |
| toDate | integer | query | Nein |
Antwort
Returns: APIGetCommentsResponse
Beispiel

Öffentliche Kommentare abrufen 
Anfrage
tenantId
urlId
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| page | integer | query | Nein | |
| direction | string | query | Nein | |
| sso | string | query | Nein | |
| skip | integer | query | Nein | |
| skipChildren | integer | query | Nein | |
| limit | integer | query | Nein | |
| limitChildren | integer | query | Nein | |
| countChildren | boolean | query | Nein | |
| fetchPageForCommentId | string | query | Nein | |
| includeConfig | boolean | query | Nein | |
| countAll | boolean | query | Nein | |
| includei10n | boolean | query | Nein | |
| locale | string | query | Nein | |
| modules | string | query | Nein | |
| isCrawler | boolean | query | Nein | |
| includeNotificationCount | boolean | query | Nein | |
| asTree | boolean | query | Nein | |
| maxTreeDepth | integer | query | Nein | |
| useFullTranslationIds | boolean | query | Nein | |
| parentId | string | query | Nein | |
| searchText | string | query | Nein | |
| hashTags | array | query | Nein | |
| userId | string | query | Nein | |
| customConfigStr | string | query | Nein | |
| afterCommentId | string | query | Nein | |
| beforeCommentId | string | query | Nein |
Antwort
Rückgabe: GetCommentsPublicResponseWithPresencePublicComment
Beispiel

Kommentartext abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| editKey | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Rückgabe: PublicAPIGetCommentTextResponse
Beispiel

Namen der Benutzer, die den Kommentar bewertet haben, abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| dir | integer | query | Yes | |
| sso | string | query | No |
Antwort
Rückgabe: GetCommentVoteUserNamesSuccessResponse
Beispiel

Kommentar sperren 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| sso | string | query | No |
Antwort
Returns: APIEmptyResponse
Beispiel

Kommentar anheften 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| sso | string | query | Nein |
Antwort
Rückgabe: ChangeCommentPinStatusResponse
Beispiel

Kommentar speichern 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| sendEmails | boolean | query | No | |
| populateNotifications | boolean | query | No |
Antwort
Returns: APISaveCommentResponse
Beispiel

Mehrere Kommentare speichern 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| isLive | boolean | query | Nein | |
| doSpamCheck | boolean | query | Nein | |
| sendEmails | boolean | query | Nein | |
| populateNotifications | boolean | query | Nein |
Antwort
Gibt zurück: SaveCommentsBulkResponse
Beispiel

Kommentartext festlegen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Antwort
Rückgabe: PublicAPISetCommentTextResponse
Beispiel

Blockierung des Benutzers aus Kommentar aufheben 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Antwort
Returns: UnblockSuccess
Beispiel

Meldung des Kommentars aufheben 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nein | |
| anonUserId | string | query | Nein |
Antwort
Rückgabe: FlagCommentResponse
Beispiel

Sperre des Kommentars aufheben 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| sso | string | query | Nein |
Antwort
Rückgabe: APIEmptyResponse
Beispiel

Anheften des Kommentars aufheben 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| sso | string | query | Nein |
Antwort
Rückgabe: ChangeCommentPinStatusResponse
Beispiel

Kommentar aktualisieren 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| contextUserId | string | query | Nein | |
| doSpamCheck | boolean | query | Nein | |
| isLive | boolean | query | Nein |
Antwort
Rückgabe: APIEmptyResponse
Beispiel

Kommentar bewerten 
Parameters
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| urlId | string | query | Ja | |
| broadcastId | string | query | Ja | |
| sessionId | string | query | Nein | |
| sso | string | query | Nein |
Response
Rückgabe: VoteResponse
Beispiel

Kommentare für Benutzer abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| userId | string | query | No | |
| direction | string | query | No | |
| repliesToUserId | string | query | No | |
| page | number | query | No | |
| includei10n | boolean | query | No | |
| locale | string | query | No | |
| isCrawler | boolean | query | No |
Antwort
Rückgabe: GetCommentsForUserResponse
Beispiel

Domain-Konfiguration hinzufügen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwort
Rückgabe: AddDomainConfigResponse
Beispiel

Domain-Konfiguration löschen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| domain | string | path | Ja |
Antwort
Rückgabe: DeleteDomainConfigResponse
Beispiel

Domain-Konfiguration abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| domain | string | path | Yes |
Rückgabe
Rückgabe: GetDomainConfigResponse
Beispiel

Domain-Konfigurationen abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwort
Rückgabe: GetDomainConfigsResponse
Beispiel

Domain-Konfiguration patchen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| domainToUpdate | string | path | Ja |
Antwort
Rückgabe: PatchDomainConfigResponse
Beispiel

Domain-Konfiguration setzen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| domainToUpdate | string | path | Yes |
Antwort
Returns: PutDomainConfigResponse
Beispiel

E-Mail-Vorlage erstellen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwort
Rückgabe: CreateEmailTemplateResponse
Beispiel

E-Mail-Vorlage löschen 
Parameters
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Response
Rückgabe: APIEmptyResponse
Beispiel

Renderfehler der E-Mail-Vorlage löschen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| errorId | string | path | Yes |
Antwort
Rückgabe: APIEmptyResponse
Beispiel

E-Mail-Vorlage abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Rückgabe: GetEmailTemplateResponse
Beispiel

E-Mail-Vorlagendefinitionen abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwort
Rückgabe: GetEmailTemplateDefinitionsResponse
Beispiel

Renderfehler der E-Mail-Vorlage abrufen 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| skip | number | query | Nein |
Antwort
Rückgabe: GetEmailTemplateRenderErrorsResponse
Beispiel

E-Mail-Vorlagen abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nein |
Antwort
Rückgabe: GetEmailTemplatesResponse
Beispiel

E-Mail-Vorlage rendern 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| locale | string | query | Nein |
Antwort
Gibt zurück: RenderEmailTemplateResponse
Beispiel

E-Mail-Vorlage aktualisieren 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Rückgabe: APIEmptyResponse
Beispiel

Ereignisprotokoll abrufen 
Anforderung tenantId urlId userIdWS
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| userIdWS | string | query | Ja | |
| startTime | integer | query | Ja | |
| endTime | integer | query | Nein |
Antwort
Rückgabe: GetEventLogResponse
Beispiel

Globales Ereignisprotokoll abrufen 
Anfrage tenantId urlId userIdWS
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| userIdWS | string | query | Ja | |
| startTime | integer | query | Ja | |
| endTime | integer | query | Nein |
Antwort
Rückgabe: GetEventLogResponse
Beispiel

Feed-Beitrag erstellen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| broadcastId | string | query | Nein | |
| isLive | boolean | query | Nein | |
| doSpamCheck | boolean | query | Nein | |
| skipDupCheck | boolean | query | Nein |
Antwort
Rückgabe: CreateFeedPostsResponse
Beispiel

Öffentlichen Feed-Beitrag erstellen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | Pfad | Ja | |
| broadcastId | string | Abfrage | Nein | |
| sso | string | Abfrage | Nein |
Antwort
Rückgabe: CreateFeedPostResponse
Beispiel

Öffentlichen Feed-Beitrag löschen 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postId | string | path | Ja | |
| broadcastId | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Rückgabe: DeleteFeedPostPublicResponse
Beispiel

Öffentliche Feed-Beiträge abrufen 
req tenantId afterId
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| afterId | string | query | No | |
| limit | integer | query | No | |
| tags | array | query | No | |
| sso | string | query | No | |
| isCrawler | boolean | query | No | |
| includeUserInfo | boolean | query | No |
Antwort
Returns: PublicFeedPostsResponse
Beispiel

Statistiken der Feed-Beiträge abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postIds | array | query | Ja | |
| sso | string | query | Nein |
Antwort
Rückgabe: FeedPostsStatsResponse
Beispiel

Öffentliche Reaktionen eines Benutzers abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | Pfad | Ja | |
| postIds | array | Abfrage | Nein | |
| sso | string | Abfrage | Nein |
Antwort
Rückgabe: UserReactsResponse
Beispiel

Öffentlich auf Feed-Beitrag reagieren 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postId | string | path | Ja | |
| isUndo | boolean | query | Nein | |
| broadcastId | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Rückgabe: ReactFeedPostResponse
Beispiel

Feed-Beitrag aktualisieren 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Rückgabe: APIEmptyResponse
Beispiel

Öffentlichen Feed-Beitrag aktualisieren 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postId | string | path | Ja | |
| broadcastId | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Rückgabe: CreateFeedPostResponse
Beispiel

Öffentliches Kommentarmelden 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| isFlagged | boolean | query | Yes | |
| sso | string | query | No |
Antwort
Rückgabe: APIEmptyResponse
Beispiel

Großes GIF abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| largeInternalURLSanitized | string | query | Ja |
Antwort
Rückgabe: GifGetLargeResponse
Beispiel

GIF-Suche abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| search | string | query | Ja | |
| locale | string | query | Nein | |
| rating | string | query | Nein | |
| page | number | query | Nein |
Antwort
Rückgabe: GetGifsSearchResponse
Beispiel

Trend-GIFs abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| locale | string | query | Nein | |
| rating | string | query | Nein | |
| page | number | query | Nein |
Antwort
Rückgabe: GetGifsTrendingResponse
Beispiel

Hashtag hinzufügen 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwort
Rückgabe: CreateHashTagResponse
Beispiel

Mehrere Hashtags hinzufügen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwort
Rückgabe: BulkCreateHashTagsResponse
Beispiel

Hashtag löschen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| tag | string | path | Yes |
Response
Rückgabe: APIEmptyResponse
Beispiel

Hashtags abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| page | number | query | Nein |
Antwort
Rückgabe: GetHashTagsResponse
Beispiel

Hashtag patchen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| tag | string | path | Yes |
Antwort
Rückgabe: UpdateHashTagResponse
Beispiel

Moderationsabstimmung löschen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| voteId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Antwort
Rückgabe: VoteDeleteResponse
Beispiel

API-Kommentare abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| page | number | query | No | |
| count | number | query | No | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sorts | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
Antwort
Rückgabe: ModerationAPIGetCommentsResponse
Beispiel

API-Exportstatus abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| batchJobId | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Rückgabe: ModerationExportStatusResponse
Beispiel

API-IDs abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| afterId | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
Antwort
Rückgabe: ModerationAPIGetCommentIdsResponse
Beispiel

Benutzer, die aus Kommentaren verbannt sind, abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nein |
Antwort
Rückgabe: GetBannedUsersFromCommentResponse
Beispiel

Kommentar-Bannstatus abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Antwort
Rückgabe: GetCommentBanStatusResponse
Beispiel

Kinderkommentare abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nein |
Antwort
Rückgabe: ModerationAPIChildCommentsResponse
Beispiel

Anzahl abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| text-search | string | query | Nein | |
| byIPFromComment | string | query | Nein | |
| filter | string | query | Nein | |
| searchFilters | string | query | Nein | |
| demo | boolean | query | Nein | |
| sso | string | query | Nein |
Antwort
Rückgabe: ModerationAPICountCommentsResponse
Beispiel

Anzahlen abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nein |
Antwort
Rückgabe: GetBannedUsersCountResponse
Beispiel

Protokolle abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nein |
Antwort
Rückgabe: ModerationAPIGetLogsResponse
Beispiel

Manuelle Abzeichen abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nein |
Antwort
Rückgabe: GetTenantManualBadgesResponse
Beispiel

Manuelle Abzeichen für Benutzer abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| badgesUserId | string | query | Nein | |
| commentId | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Rückgabe: GetUserManualBadgesResponse
Beispiel

Moderationskommentar abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| includeEmail | boolean | query | Nein | |
| includeIP | boolean | query | Nein | |
| sso | string | query | Nein |
Antwort
Rückgabe: ModerationAPICommentResponse
Beispiel

Moderationskommentartext abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nein |
Antwort
Rückgabe: GetCommentTextResponse
Beispiel

Vorab-Bann-Zusammenfassung abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| includeByUserIdAndEmail | boolean | query | Nein | |
| includeByIP | boolean | query | Nein | |
| includeByEmailDomain | boolean | query | Nein | |
| sso | string | query | Nein |
Antwort
Rückgabe: PreBanSummary
Beispiel

Zusammenfassung der Suchkommentare abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sso | string | query | No |
Antwort
Rückgabe: ModerationCommentSearchResponse
Beispiel

Suchseiten abrufen 
Parameters
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| value | string | query | Nein | |
| sso | string | query | Nein |
Response
Returns: ModerationPageSearchResponse
Beispiel

Suchseiten (Sites) abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| value | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Rückgabe: ModerationSiteSearchResponse
Beispiel

Suchvorschläge abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| text-search | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Rückgabe: ModerationSuggestResponse
Beispiel

Benutzer suchen 
Parameters
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| value | string | query | Nein | |
| sso | string | query | Nein |
Response
Rückgabe: ModerationUserSearchResponse
Example

Trust-Faktor abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Rückgabe: GetUserTrustFactorResponse
Beispiel

Benutzer-Bannpräferenz abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nein |
Antwort
Rückgabe: APIModerateGetUserBanPreferencesResponse
Beispiel

Internes Benutzerprofil abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Rückgabe: GetUserInternalProfileResponse
Beispiel

Kommentarabstimmungen anpassen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Rückgabe: AdjustVotesResponse
Beispiel

API-Export durchführen 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sorts | string | query | No | |
| sso | string | query | No |
Antwort
Returns: ModerationExportResponse
Beispiel

Benutzer aus Kommentar bannen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| banEmail | boolean | query | No | |
| banEmailDomain | boolean | query | No | |
| banIP | boolean | query | No | |
| deleteAllUsersComments | boolean | query | No | |
| bannedUntil | string | query | No | |
| isShadowBan | boolean | query | No | |
| updateId | string | query | No | |
| banReason | string | query | No | |
| sso | string | query | No |
Antwort
Rückgabe: BanUserFromCommentResult
Beispiel

Bann von Benutzer rückgängig machen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Antwort
Rückgabe: APIEmptyResponse
Beispiel

Mehrfache Vorab-Bann-Zusammenfassung 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| includeByUserIdAndEmail | boolean | query | Nein | |
| includeByIP | boolean | query | Nein | |
| includeByEmailDomain | boolean | query | Nein | |
| sso | string | query | Nein |
Antwort
Rückgabe: BulkPreBanSummary
Beispiel

Kommentare nach IDs posten 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nein |
Antwort
Rückgabe: ModerationAPIChildCommentsResponse
Beispiel

Kommentar melden 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Antwort
Rückgabe: APIEmptyResponse
Beispiel

Kommentar entfernen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Rückgabe: PostRemoveCommentApiResponse
Beispiel

Gelöschten Kommentar wiederherstellen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Antwort
Returns: APIEmptyResponse
Beispiel

Genehmigungsstatus des Kommentars setzen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| approved | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Antwort
Rückgabe: SetCommentApprovedResponse
Beispiel

Überprüfungsstatus des Kommentars setzen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| reviewed | boolean | query | Nein | |
| broadcastId | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Rückgabe: APIEmptyResponse
Beispiel

Spam-Status des Kommentars setzen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| spam | boolean | query | Nein | |
| permNotSpam | boolean | query | Nein | |
| broadcastId | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Rückgabe: APIEmptyResponse
Beispiel

Kommentartext setzen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Rückgabe: SetCommentTextResponse
Beispiel

Meldung des Kommentars aufheben 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Antwort
Returns: APIEmptyResponse
Beispiel

Abstimmung posten 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| direction | string | query | Nein | |
| broadcastId | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Returns: VoteResponse
Beispiel

Abzeichen vergeben 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgeId | string | query | Yes | |
| userId | string | query | No | |
| commentId | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Antwort
Rückgabe: AwardUserBadgeResponse
Beispiel

Thread schließen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No |
Antwort
Rückgabe: APIEmptyResponse
Beispiel

Abzeichen entfernen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| badgeId | string | query | Ja | |
| userId | string | query | Nein | |
| commentId | string | query | Nein | |
| broadcastId | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Returns: RemoveUserBadgeResponse
Beispiel

Thread wieder öffnen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No |
Antwort
Rückgabe: APIEmptyResponse
Beispiel

Trust-Faktor setzen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| trustFactor | string | query | No | |
| sso | string | query | No |
Antwort
Rückgabe: SetUserTrustFactorResponse
Beispiel

Moderator erstellen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwort
Rückgabe: CreateModeratorResponse
Beispiel

Moderator löschen 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| sendEmail | string | query | No |
Antwort
Rückgabe: APIEmptyResponse
Beispiel

Moderator abrufen 
Parameters
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Response
Rückgabe: GetModeratorResponse
Example

Moderatoren abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nein |
Antwort
Returns: GetModeratorsResponse
Beispiel

Einladung senden 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| fromName | string | query | Ja |
Antwort
Rückgabe: APIEmptyResponse
Beispiel

Moderator aktualisieren 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Rückgabe: APIEmptyResponse
Beispiel

Benachrichtigungszähler löschen 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Rückgabe: APIEmptyResponse
Beispiel

Zwischengespeicherten Benachrichtigungszähler abrufen 
Parameters
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Response
Rückgabe: GetCachedNotificationCountResponse
Example

Benachrichtigungszähler abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nein | |
| urlId | string | query | Nein | |
| fromCommentId | string | query | Nein | |
| viewed | boolean | query | Nein | |
| type | string | query | Nein |
Antwort
Rückgabe: GetNotificationCountResponse
Beispiel

Benachrichtigungen abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nein | |
| urlId | string | query | Nein | |
| fromCommentId | string | query | Nein | |
| viewed | boolean | query | Nein | |
| type | string | query | Nein | |
| skip | number | query | Nein |
Antwort
Rückgabe: GetNotificationsResponse
Beispiel

Benachrichtigung aktualisieren 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nein |
Antwort
Rückgabe: APIEmptyResponse
Beispiel

V1-Seitenreaktion erstellen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| title | string | query | Nein |
Antwort
Rückgabe: CreateV1PageReact
Beispiel

V2-Seitenreaktion erstellen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| id | string | query | Ja | |
| title | string | query | Nein |
Antwort
Rückgabe: CreateV1PageReact
Beispiel

V1-Seitenreaktion löschen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes |
Antwort
Rückgabe: CreateV1PageReact
Beispiel

V2-Seitenreaktion löschen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| id | string | query | Yes |
Antwort
Rückgabe: CreateV1PageReact
Beispiel

V1-Seiten-Likes abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja |
Antwort
Rückgabe: GetV1PageLikes
Beispiel

V2-Seitenreaktionen abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja |
Antwort
Rückgabe: GetV2PageReacts
Beispiel

V2-Seitenreaktionsbenutzer abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| id | string | query | Yes |
Antwort
Rückgabe: GetV2PageReactUsersResponse
Beispiel

Seite hinzufügen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwort
Rückgabe: AddPageAPIResponse
Beispiel

Seite löschen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Rückgabe: DeletePageAPIResponse
Beispiel

Offline-Benutzer abrufen 
Past commenters on the page who are NOT currently online. Sorted by displayName.
Use this after exhausting /users/online to render a “Members” section.
Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName} index from afterName forward via $gt, no $skip cost.
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Seiten-URL-Bezeichner (serverseitig bereinigt). |
| afterName | string | query | No | Cursor: übergeben Sie nextAfterName aus der vorherigen Antwort. |
| afterUserId | string | query | No | Cursor‑Tiebreaker: übergeben Sie nextAfterUserId aus der vorherigen Antwort. Erforderlich, wenn afterName gesetzt ist, damit Namensbindungen keine Einträge verlieren. |
Antwort
Rückgabe: PageUsersOfflineResponse
Beispiel

Online-Benutzer abrufen 
Derzeit online Viewer einer Seite: Personen, deren Websocket‑Session gerade die Seite abonniert.
Gibt anonCount + totalCount zurück (raumweite Abonnenten, einschließlich anonymer Viewer, die wir nicht aufzählen).
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | Seiten‑URL‑Kennzeichen (serverseitig bereinigt). |
| afterName | string | query | Nein | Cursor: übergebe nextAfterName aus der vorherigen Antwort. |
| afterUserId | string | query | Nein | Cursor‑Tiebreaker: übergebe nextAfterUserId aus der vorherigen Antwort. Erforderlich, wenn afterName gesetzt ist, damit Namens‑Tie‑Einträge nicht weggelassen werden. |
Antwort
Gibt zurück: PageUsersOnlineResponse
Beispiel

Seite nach URL-ID abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja |
Antwort
Rückgabe: GetPageByURLIdAPIResponse
Beispiel

Seiten abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Antwort
Rückgabe: GetPagesAPIResponse
Beispiel

Öffentliche Seiten abrufen 
List pages for a tenant. Used by the FChat desktop client to populate its room list.
Requires enableFChat to be true on the resolved custom config for each page.
Pages that require SSO are filtered against the requesting user's group access.
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| cursor | string | query | No | Undurchsichtiger Paginierungs‑Cursor, zurückgegeben als nextCursor von einer vorherigen Anforderung. Gebunden an das gleiche sortBy. |
| limit | integer | query | No | 1..200, Standard 50 |
| q | string | query | No | Optionaler, nicht‑groß-/kleinschreibungsempfindlicher Titelfilter‑Präfix. |
| sortBy | string | query | No | Sortierreihenfolge. updatedAt (Standard, neueste zuerst), commentCount (meiste Kommentare zuerst) oder title (alphabetisch). |
| hasComments | boolean | query | No | Wenn true, nur Seiten zurückgeben, die mindestens einen Kommentar enthalten. |
Antwort
Rückgabe: GetPublicPagesResponse
Beispiel

Benutzerinformationen abrufen 
Bulk-Benutzerinformationen für einen Mandanten. Anhand von userIds werden Anzeigeninformationen aus User / SSOUser zurückgegeben.
Wird vom Kommentar‑Widget verwendet, um Benutzer zu ergänzen, die gerade über ein Präsenzereignis erschienen sind.
Kein Seitenkontext: Datenschutz wird einheitlich durchgesetzt (private Profile werden maskiert).
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| ids | string | query | Ja | Kommagetrennte userIds. |
Antwort
Rückgabe: PageUsersInfoResponse
Beispiel

Seite patchen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Rückgabe: PatchPageAPIResponse
Beispiel

Ausstehendes Webhook-Ereignis löschen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Rückgabe: APIEmptyResponse
Beispiel

Anzahl ausstehender Webhook-Ereignisse abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | query | Nein | |
| externalId | string | query | Nein | |
| eventType | string | query | Nein | |
| type | string | query | Nein | |
| domain | string | query | Nein | |
| attemptCountGT | number | query | Nein |
Antwort
Rückgabe: GetPendingWebhookEventCountResponse
Beispiel

Ausstehende Webhook-Ereignisse abrufen 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | No | |
| externalId | string | query | No | |
| eventType | string | query | No | |
| type | string | query | No | |
| domain | string | query | No | |
| attemptCountGT | number | query | No | |
| skip | number | query | No |
Antwort
Rückgabe: GetPendingWebhookEventsResponse
Beispiel

Fragenkonfiguration erstellen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwort
Returns: CreateQuestionConfigResponse
Beispiel

Fragenkonfiguration löschen 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Returns: APIEmptyResponse
Beispiel

Fragenkonfiguration abrufen 
Parameter
| Name | Typ | Standort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Returns: GetQuestionConfigResponse
Beispiel

Fragenkonfigurationen abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| skip | number | query | No |
Antwort
Rückgabe: GetQuestionConfigsResponse
Beispiel

Fragenkonfiguration aktualisieren 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Rückgabe: APIEmptyResponse
Beispiel

Fragergebnis erstellen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwort
Rückgabe: CreateQuestionResultResponse
Beispiel

Fragergebnis löschen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Antwort
Rückgabe: APIEmptyResponse
Beispiel

Fragergebnis abrufen 
Parameters
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Response
Returns: GetQuestionResultResponse
Example

Fragergebnisse abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Nein | |
| userId | string | query | Nein | |
| startDate | string | query | Nein | |
| questionId | string | query | Nein | |
| questionIds | string | query | Nein | |
| skip | number | query | Nein |
Antwort
Returns: GetQuestionResultsResponse
Beispiel

Fragergebnis aktualisieren 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Antwort
Rückgabe: APIEmptyResponse
Beispiel

Fragergebnisse aggregieren 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| questionId | string | query | No | |
| questionIds | array | query | No | |
| urlId | string | query | No | |
| timeBucket | string | query | No | |
| startDate | string | query | No | |
| forceRecalculate | boolean | query | No |
Antwort
Rückgabe: AggregateQuestionResultsResponse
Beispiel

Mehrfachaggregation von Fragergebnissen 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| forceRecalculate | boolean | query | No |
Antwort
Rückgabe: BulkAggregateQuestionResultsResponse
Beispiel

Kommentare mit Fragergebnissen kombinieren 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| questionId | string | query | Nein | |
| questionIds | array | query | Nein | |
| urlId | string | query | Nein | |
| startDate | string | query | Nein | |
| forceRecalculate | boolean | query | Nein | |
| minValue | number | query | Nein | |
| maxValue | number | query | Nein | |
| limit | number | query | Nein |
Antwort
Rückgabe: CombineQuestionResultsWithCommentsResponse
Beispiel

SSO-Benutzer hinzufügen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwort
Rückgabe: AddSSOUserAPIResponse
Beispiel

SSO-Benutzer löschen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| deleteComments | boolean | query | Nein | |
| commentDeleteMode | string | query | Nein |
Antwort
Gibt zurück: DeleteSSOUserAPIResponse
Beispiel

SSO-Benutzer per E-Mail abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | Abfrage | Ja | |
| string | Pfad | Ja |
Antwort
Rückgabe: GetSSOUserByEmailAPIResponse
Beispiel

SSO-Benutzer per ID abrufen 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Rückgabe: GetSSOUserByIdAPIResponse
Beispiel

SSO-Benutzer abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | integer | query | Nein |
Antwort
Rückgabe: GetSSOUsersResponse
Beispiel

SSO-Benutzer patchen 
Parameters
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| updateComments | boolean | query | No |
Antwort
Rückgabe: PatchSSOUserAPIResponse
Beispiel

SSO-Benutzer setzen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| updateComments | boolean | query | Nein |
Antwort
Rückgabe: PutSSOUserAPIResponse
Beispiel

Abonnement erstellen 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwort
Returns: CreateSubscriptionAPIResponse
Beispiel

Abonnement löschen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nein |
Antwort
Rückgabe: DeleteSubscriptionAPIResponse
Beispiel

Abonnements abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nein |
Antwort
Rückgabe: GetSubscriptionsAPIResponse
Beispiel

Abonnement aktualisieren 
Parameters
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No |
Response
Rückgabe: UpdateSubscriptionAPIResponse
Beispiel

Tägliche Nutzung des Mandanten abrufen 
Parameters
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| yearNumber | number | query | Nein | |
| monthNumber | number | query | Nein | |
| dayNumber | number | query | Nein | |
| skip | number | query | Nein |
Response
Rückgabe: GetTenantDailyUsagesResponse
Example

Mandantenpaket erstellen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwort
Rückgabe: CreateTenantPackageResponse
Beispiel

Mandantenpaket löschen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Rückgabe: APIEmptyResponse
Beispiel

Mandantenpaket abrufen 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Rückgabe: GetTenantPackageResponse
Beispiel

Mandantenpakete abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nein |
Antwort
Rückgabe: GetTenantPackagesResponse
Beispiel

Mandantenpaket ersetzen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Antwort
Rückgabe: APIEmptyResponse
Beispiel

Mandantenpaket aktualisieren 
Parameters
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Rückgabe: APIEmptyResponse
Beispiel

Mandantenbenutzer erstellen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwort
Rückgabe: CreateTenantUserResponse
Beispiel

Mandantenbenutzer löschen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| deleteComments | string | query | No | |
| commentDeleteMode | string | query | No |
Antwort
Rückgabe: APIEmptyResponse
Beispiel

Mandantenbenutzer abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Rückgabe: GetTenantUserResponse
Beispiel

Mandantenbenutzer abrufen 
Parameter
| Name | Type | Location | Required | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| skip | number | query | No |
Antwort
Rückgabe: GetTenantUsersResponse
Beispiel

Mandantenbenutzer ersetzen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| updateComments | string | query | No |
Antwort
Rückgabe: APIEmptyResponse
Beispiel

Login-Link senden 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| redirectURL | string | query | Nein |
Antwort
Rückgabe: APIEmptyResponse
Beispiel

Mandantenbenutzer aktualisieren 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| updateComments | string | query | Nein |
Antwort
Returns: APIEmptyResponse
Beispiel

Mandant erstellen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwort
Rückgabe: CreateTenantResponse
Beispiel

Mandant löschen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| sure | string | query | Nein |
Antwort
Rückgabe: APIEmptyResponse
Beispiel

Mandant abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Rückgabe: GetTenantResponse
Beispiel

Mandanten abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| meta | string | query | Nein | |
| skip | number | query | Nein |
Antwort
Rückgabe: GetTenantsResponse
Beispiel

Mandant aktualisieren 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Returns: APIEmptyResponse
Beispiel

Ticketstatus ändern 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Rückgabe: ChangeTicketStateResponse
Beispiel

Ticket erstellen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Ja |
Antwort
Rückgabe: CreateTicketResponse
Beispiel

Ticket abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No |
Antwort
Rückgabe: GetTicketResponse
Beispiel

Tickets abrufen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| state | number | query | No | |
| skip | number | query | No | |
| limit | number | query | No |
Response
Rückgabe: GetTicketsResponse
Example

Übersetzungen abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| namespace | string | path | Ja | |
| component | string | path | Ja | |
| locale | string | query | Nein | |
| useFullTranslationIds | boolean | query | Nein |
Antwort
Rückgabe: GetTranslationsResponse
Beispiel

Bild hochladen 
Upload and resize an image
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| sizePreset | string | query | No | Größen‑Voreinstellung: "Default" (1000x1000px) oder "CrossPlatform" (erstellt Größen für gängige Geräte) |
| urlId | string | query | No | Seiten‑ID, von der der Upload erfolgt, zur Konfiguration |
Response
Returns: UploadImageResponse
Example

Benutzer-Abzeichen-Fortschritt nach ID abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Antwort
Rückgabe: APIGetUserBadgeProgressResponse
Beispiel

Benutzer-Abzeichen-Fortschritt nach Benutzer-ID abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | path | Yes |
Antwort
Rückgabe: APIGetUserBadgeProgressResponse
Beispiel

Liste des Benutzer-Abzeichen-Fortschritts abrufen 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nein | |
| limit | number | query | Nein | |
| skip | number | query | Nein |
Antwort
Returns: APIGetUserBadgeProgressListResponse
Beispiel

Benutzerabzeichen erstellen 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Antwort
Rückgabe: APICreateUserBadgeResponse
Beispiel

Benutzerabzeichen löschen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Rückgabe: APIEmptySuccessResponse
Beispiel

Benutzerabzeichen abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Antwort
Returns: APIGetUserBadgeResponse
Beispiel

Benutzerabzeichen abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nein | |
| badgeId | string | query | Nein | |
| type | number | query | Nein | |
| displayedOnComments | boolean | query | Nein | |
| limit | number | query | Nein | |
| skip | number | query | Nein |
Antwort
Rückgabe: APIGetUserBadgesResponse
Beispiel

Benutzerabzeichen aktualisieren 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Antwort
Returns: APIEmptySuccessResponse
Beispiel

Benutzerbenachrichtigungszähler abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Antwort
Rückgabe: GetUserNotificationCountResponse
Beispiel

Benutzerbenachrichtigungen abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | No | Wird verwendet, um zu bestimmen, ob die aktuelle Seite abonniert ist. |
| pageSize | integer | query | No | |
| afterId | string | query | No | |
| includeContext | boolean | query | No | |
| afterCreatedAt | integer | query | No | |
| unreadOnly | boolean | query | No | |
| dmOnly | boolean | query | No | |
| noDm | boolean | query | No | |
| includeTranslations | boolean | query | No | |
| includeTenantNotifications | boolean | query | No | |
| sso | string | query | No |
Antwort
Rückgabe: GetMyNotificationsResponse
Beispiel

Benutzerbenachrichtigungszähler zurücksetzen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nein |
Antwort
Rückgabe: ResetUserNotificationsResponse
Beispiel

Benutzerbenachrichtigungen zurücksetzen 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| afterId | string | query | No | |
| afterCreatedAt | integer | query | No | |
| unreadOnly | boolean | query | No | |
| dmOnly | boolean | query | No | |
| noDm | boolean | query | No | |
| sso | string | query | No |
Antwort
Rückgabe: ResetUserNotificationsResponse
Beispiel

Kommentar-Abonnement-Status der Benutzerbenachrichtigung aktualisieren 
Enable or disable notifications for a specific comment.
Parameters
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| notificationId | string | path | Yes | |
| optedInOrOut | string | path | Yes | |
| commentId | string | query | Yes | |
| sso | string | query | No |
Response
Rückgabe: UpdateUserNotificationCommentSubscriptionStatusResponse
Example

Seiten-Abonnement-Status der Benutzerbenachrichtigung aktualisieren 
Enable or disable notifications for a page. When users are subscribed to a page, notifications are created for new root comments, and also
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja | |
| url | string | query | Ja | |
| pageTitle | string | query | Ja | |
| subscribedOrUnsubscribed | string | path | Ja | |
| sso | string | query | Nein |
Antwort
Rückgabe: UpdateUserNotificationPageSubscriptionStatusResponse
Beispiel

Benutzerbenachrichtigungsstatus aktualisieren 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| notificationId | string | path | Ja | |
| newStatus | string | path | Ja | |
| sso | string | query | Nein |
Antwort
Rückgabe: UpdateUserNotificationStatusResponse
Beispiel

Anwesenheitsstatus der Benutzer abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlIdWS | string | query | Ja | |
| userIds | string | query | Ja |
Antwort
Rückgabe: GetUserPresenceStatusesResponse
Beispiel

Benutzer suchen 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| usernameStartsWith | string | query | Nein | |
| mentionGroupIds | array | query | Nein | |
| sso | string | query | Nein | |
| searchSection | string | query | Nein |
Antwort
Rückgabe: SearchUsersResult
Beispiel

Benutzer abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Rückgabe: GetUserResponse
Beispiel

Abstimmung erstellen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | Yes | |
| direction | string | query | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Antwort
Rückgabe: VoteResponse
Beispiel

Abstimmung löschen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| editKey | string | query | Nein |
Antwort
Rückgabe: VoteDeleteResponse
Beispiel

Abstimmungen abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja |
Antwort
Rückgabe: GetVotesResponse
Beispiel

Abstimmungen für Benutzer abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja | |
| userId | string | query | Nein | |
| anonUserId | string | query | Nein |
Antwort
Rückgabe: GetVotesForUserResponse
Beispiel

Brauchen Sie Hilfe?
If you encounter any issues or have questions about the Dart SDK, please:
Beitragen
Contributions are welcome! Please visit the GitHub repository for contribution guidelines.