
Sprog 🇩🇰 Dansk
Dokumentation
Kom i gang
API-referencer
Agent-lejere
Aggregat
Audit-logs
Godkendelse
Batch-job
Blokering fra kommentar
Tjek blokerede kommentarer
Kommentarer
Kommentarer for bruger
Domænekonfigurationer
E-mail-skabeloner
Hændelseslog
Feed-indlæg
Flag kommentar
GIF'er
Hashtags
Mig
Moderation
Moderatorer
Notifikationsantal
Notifikationer
Side-reaktioner
Sider
Afventende webhook-hændelser
Afstemningsstemmer
Afstemninger
Spørgsmålskonfigurationer
Spørgsmålsresultater
Aggregering af spørsmålsresultater
SSO-brugere
Abonnementer
Lejers daglige brug
Lejers pakker
Lejers brugere
Lejere
Billetter
Oversættelser
Upload billede
Brugerbadge fremskridt
Brugerbadges
Bruger notifikationer
Bruger tilstedeværelsesstatus
Bruger søgning
Brugere
Stemmer
Webhooks
FastComments Swift SDK
Dette er den officielle Swift SDK til FastComments.
Officiel Swift SDK til FastComments API'et
Repository
AI-kodningsagenter 
Giv din kodeagent den FastComments‑kontekst, den har brug for – widgets, konfiguration, Secure SSO, REST‑API‑en og SDK‑erne:
npx skills add fastcomments/skills
Fungerer med Claude Code, Codex, Cursor, Copilot, Gemini og enhver anden agent, som skills CLI understøtter.
Installation 
Swift Package Manager
Tilføj følgende til din Package.swift fil:
dependencies: [
.package(url: "https://github.com/fastcomments/fastcomments-swift.git", from: "3.1.2")
]
Eller i Xcode:
- File > Add Packages...
- Indtast repository-URL'en:
https://github.com/fastcomments/fastcomments-swift.git - Vælg den version, du vil bruge
Krav
- Swift 5.9+
- iOS 13.0+ / macOS 10.15+ / tvOS 13.0+ / watchOS 6.0+
Biblioteksindhold 
The FastComments Swift SDK består af flere moduler:
-
Client Module - API-klient til FastComments REST-API'er
- Fuldstændige typedefinitioner for alle API-modeller
- Autentificerede (
DefaultAPI), offentlige (PublicAPI) og moderationsmetoder (ModerationAPI) - Fuld understøttelse af async/await
- Se client/README.md for detaljeret API-dokumentation
-
SSO Module - Server-side Single Sign-On-værktøjer
- Sikker token-generering til brugergodkendelse
- Understøtter både simple og sikre SSO-tilstande
- HMAC-SHA256-baseret token-signering ved hjælp af CryptoKit
Hurtig start 
Brug af den offentlige API
import FastCommentsSwift
// Hent kommentarer for en side
do {
let response = try await PublicAPI.getCommentsPublic(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
print("Found \(response.comments?.count ?? 0) comments")
for comment in response.comments ?? [] {
print("Comment: \(comment.comment ?? "")")
}
} catch {
print("Error fetching comments: \(error)")
}
Brug af den autentificerede API
import FastCommentsSwift
// Konfigurer din API-nøgle i den delte konfiguration (sendt som x-api-key-headeren)
FastCommentsSwiftAPIConfiguration.shared.customHeaders["x-api-key"] = "your-api-key"
// Hent kommentarer ved brug af den autentificerede API
do {
let response = try await DefaultAPI.getComments(
tenantId: "your-tenant-id",
options: .init(urlId: "page-url-id")
)
print("Total comments: \(response.count ?? 0)")
for comment in response.comments ?? [] {
print("Comment ID: \(comment.id ?? ""), Text: \(comment.comment ?? "")")
}
} catch {
print("Error: \(error)")
}
Brug af Moderations-API
import FastCommentsSwift
// Moderationsmetoder er autoriseret med en `sso`-token for den handlende moderator
// (generer den med FastCommentsSSO, se SSO-sektionen ovenfor).
do {
let response = try await ModerationAPI.getApiComments(
options: .init(
page: 0,
count: 30,
sso: ssoToken
)
)
print("Found \(response.comments.count) comments to moderate")
for comment in response.comments {
print("Comment ID: \(comment.id), Text: \(comment.commentHTML)")
}
} catch {
print("Error: \(error)")
}
Brug af SSO til autentificering
Sikker SSO (Anbefalet til produktion)
import FastCommentsSwift
let apiKey = "your-api-key"
// Opret sikker SSO-brugerdata (kun server-side!)
let userData = SecureSSOUserData(
id: "user-123", // Bruger-ID
email: "user@example.com", // E-mail
username: "johndoe", // Brugernavn
avatar: "https://example.com/avatar.jpg" // Avatar-URL
)
// Generer SSO-token
do {
let sso = try FastCommentsSSO.createSecure(apiKey: apiKey, secureSSOUserData: userData)
let token = try sso.createToken()
print("SSO Token: \(token ?? "")")
// Send denne token til din frontend for autentificering
} catch {
print("Error creating SSO token: \(error)")
}
Simpel SSO (Til udvikling/testning)
import FastCommentsSwift
// Opret simpel SSO-brugerdata (ingen API-nøgle nødvendig)
let userData = SimpleSSOUserData(
username: "johndoe",
email: "user@example.com",
avatar: "https://example.com/avatar.jpg"
)
// Generer simpel SSO-token
let sso = FastCommentsSSO.createSimple(simpleSSOUserData: userData)
do {
let token = try sso.createToken()
print("Simple SSO Token: \(token ?? "")")
} catch {
print("Error creating SSO token: \(error)")
}
API-klienter 
FastComments SDK'en giver tre API-klienter:
PublicAPI - Klientsikre metoder
PublicAPI indeholder metoder, der er sikre at kalde fra klient-side kode (iOS/macOS-apps). Disse metoder:
- Kræver ikke en API-nøgle
- Kan bruge SSO-tokens til autentificering
- Er rate-begrænsede pr. bruger/enhed
- Er velegnede til applikationer rettet mod slutbrugere
Eksempel på brugsscenarie: Hentning og oprettelse af kommentarer i din iOS-app
DefaultAPI - Server-side metoder
DefaultAPI indeholder autentificerede metoder, der kræver en API-nøgle. Disse metoder:
- Kræver din FastComments API-nøgle
- Skun KUN kaldes fra server-side kode
- Giver fuld adgang til dine FastComments-data
- Er rate-begrænsede pr. tenant
Eksempel på brugsscenarie: Administrative operationer, bulk-dataeksport, brugeradministration
ModerationAPI - Metoder til moderator-dashboardet
ModerationAPI giver en omfattende suite af live- og hurtige moderations-API'er. Hver ModerationAPI-metode accepterer en sso-parameter og kan autentificeres via SSO eller en FastComments.com-sessioncookie.
Eksempel på brugsscenarie: Opbygning af en moderationsoplevelse for moderatorer af dit community
VIGTIGT: Udsend aldrig din API-nøgle i klient-side kode. API-nøgler bør kun bruges server-side.
Udførelse af API-kald 
Swift SDK'en bruger moderne async/await-syntaks til alle API‑kald:
let response = try await PublicAPI.getCommentsPublic(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
Almindelige problemer 
401 Uautoriserede fejl
Hvis du får 401-fejl, når du bruger den autentificerede API:
- Kontrollér din API-nøgle: Sørg for, at du bruger den korrekte API-nøgle fra dit FastComments-dashboard
- Bekræft lejer-ID'et: Sørg for, at lejer-ID'et stemmer overens med din konto
- API-nøgleformat: API-nøglen skal sættes som
x-api-keyheaderen i den delte konfiguration:
FastCommentsSwiftAPIConfiguration.shared.customHeaders["x-api-key"] = "YOUR_API_KEY"
- Brug af den forkerte API: Sørg for, at du bruger
DefaultAPI(ikkePublicAPI) til autentificerede kald
SSO-tokenproblemer
Hvis SSO-tokens ikke virker:
- Brug sikker tilstand til produktion: Brug altid
FastCommentsSSO.createSecure()med din API-nøgle til produktion - Kun på serversiden: Generér sikre SSO-tokens på din server, og udsæt aldrig din API-nøgle for klienter
- Kontrollér brugerdata: Sørg for, at alle krævede felter (id, e‑mail, brugernavn) er angivet
- Tokenudløb: Sikker SSO-tokens indeholder et tidsstempel og kan udløbe. Generér friske tokens efter behov.
SSL/TLS-fejl
Hvis du støder på SSL/TLS-fejl:
- Sørg for, at din apps Info.plist tillader HTTPS-forbindelser til fastcomments.com
- Kontrollér, at du ikke bruger App Transport Security-undtagelser, som kan blokere forbindelsen.
Noter 
Broadcast-ID'er
Du vil se, at du skal sende et broadcastId i nogle API-kald. Når du modtager hændelser, får du dette ID tilbage, så du ved, at du kan ignorere hændelsen, hvis du planlægger at anvende ændringer optimistisk på klienten (hvilket du sandsynligvis vil gøre, da det giver den bedste oplevelse). Pass et UUID her. ID'et bør være unikt nok til ikke at forekomme to gange i en session.
let broadcastId = UUID().uuidString
createAgentTenant 
Opretter en ny prøvekonto til en AI-agent uden menneskelig tilmelding. Der er ikke behov for en API-nøgle for at kalde denne.
Svaret indeholder tenant-id'et, en API-nøgle, der fungerer med det samme mod REST API'et og MCP-serveren, samt en claim-URL. Giv claim-URL'en til den person, du arbejder for: når den åbnes, mens man er logget ind på FastComments, tilknyttes kontoen denne person. Ikke-claimede konti, og deres nøgler, slettes 72 timer efter oprettelse. Indtil den er claimet, har kontoen de standard begrænsninger for prøveversioner.
Response
Returnerer: CreateAgentTenantResponse
Eksempel

aggregere 
Aggregere dokumenter ved at gruppere dem (hvis groupBy er angivet) og anvende flere operationer. Forskellige operationer (f.eks. sum, countDistinct, avg osv.) understøttes.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| parentTenantId | string | query | No | |
| includeStats | boolean | query | No |
Response
Returns: AggregateResponse
Example

getAuditLogs 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | Lejeren, som revisionslogfiler skal læses for. |
| limit | integer | query | No | Hvor mange logfiler der skal returneres. Max 10000, standard er 1000. |
| skip | integer | query | No | Hvor mange logfiler der skal springes over, for sideinddeling. |
| order | string | query | No | Sorteringsretning på hændelsestiden. Standard er DESC (nyeste først). |
| after | integer | query | No | |
| before | integer | query | No | |
| username | string | query | No | Returner kun hændelser udført af dette brugernavn. |
| ip | string | query | No | Returner kun hændelser fra denne IP-adresse. |
| crudType | string | query | No | Returner kun hændelser af denne type: c, r, u, d eller login. |
| resourceName | string | query | No | Returner kun hændelser for denne ressource, f.eks. Bruger eller Moderator. |
| targetId | string | query | No | Returner kun hændelser, hvor det berørte objekt har dette id. |
| target | string | query | No | Case‑insensitiv delstrengssøgning på det berørte objekts label, f.eks. et brugernavn eller en e‑mail. |
| includeManagedTenants | boolean | query | No | Returner også hændelser fra lejere, som denne lejer administrerer. |
Svar
Returnerer: GetAuditLogsResponse
Eksempel

logoutPublic 
Svar
Returnerer: APIEmptyResponse
Eksempel

getBatchJob 
Status, fremskridt og, når den er færdig, resultatet af et batch-job.
Parameters
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Response
Returnerer: GetBatchJobAPIResponse
Example

getBatchJobs 
Lejers batch-job (import, eksport, side‑migrationer...), nyeste først.
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| type | string | query | Nej | Kun job af denne type, for eksempel migrate-pages. |
| status | string | query | Nej | Kun job i denne status: requested, running, success eller failed. |
| skip | integer | query | Nej | Hvor mange job der skal springes over, for sideinddeling. |
Svar
Returnerer: GetBatchJobsAPIResponse
Eksempel

blockFromCommentPublic 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nej |
Respons
Returnerer: BlockSuccess
Eksempel

unBlockCommentPublic 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Respons
Returnerer: UnblockSuccess
Eksempel

checkedCommentsForBlocked 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentIds | string | query | Ja | En kommasepareret liste over kommentar-id'er. |
| sso | string | query | Nej |
Respons
Returnerer: CheckBlockedCommentsResponse
Eksempel

blockUserFromComment 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nej | |
| anonUserId | string | query | Nej |
Svar
Returnerer: BlockSuccess
Eksempel

createCommentPublic 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| sessionId | string | query | No | |
| sso | string | query | No | |
| locale | string | query | No |
Respons
Returnerer: SaveCommentsResponseWithPresence
Eksempel

deleteComment 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| contextUserId | string | query | Nej | |
| isLive | boolean | query | Nej |
Svar
Returnerer: DeleteCommentResult
Eksempel

deleteCommentPublic 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Svar
Returnerer: PublicAPIDeleteCommentResponse
Eksempel

deleteCommentVote 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| voteId | string | path | Ja | |
| urlId | string | query | Ja | |
| broadcastId | string | query | Ja | |
| editKey | string | query | Nej | |
| sso | string | query | Nej |
Response
Returnerer: VoteDeleteResponse
Eksempel

flagComment 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Svar
Returnerer: FlagCommentResponse
Eksempel

getComment 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIGetCommentResponse
Eksempel

getComments 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| page | integer | query | No | |
| limit | integer | query | No | |
| skip | integer | query | No | |
| asTree | boolean | query | No | |
| skipChildren | integer | query | No | |
| limitChildren | integer | query | No | |
| maxTreeDepth | integer | query | No | |
| urlId | string | query | No | |
| userId | string | query | No | |
| anonUserId | string | query | No | |
| contextUserId | string | query | No | |
| hashTag | string | query | No | |
| parentId | string | query | No | |
| direction | string | query | No | |
| fromDate | integer | query | No | |
| toDate | integer | query | No |
Svar
Returnerer: APIGetCommentsResponse
Eksempel

getCommentsPublic 
req tenantId urlId
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| page | integer | query | Nej | |
| direction | string | query | Nej | |
| sso | string | query | Nej | |
| skip | integer | query | Nej | |
| skipChildren | integer | query | Nej | |
| limit | integer | query | Nej | |
| limitChildren | integer | query | Nej | |
| countChildren | boolean | query | Nej | |
| fetchPageForCommentId | string | query | Nej | |
| includeConfig | boolean | query | Nej | |
| countAll | boolean | query | Nej | |
| includei10n | boolean | query | Nej | |
| locale | string | query | Nej | |
| modules | string | query | Nej | |
| isCrawler | boolean | query | Nej | |
| includeNotificationCount | boolean | query | Nej | |
| asTree | boolean | query | Nej | |
| maxTreeDepth | integer | query | Nej | |
| useFullTranslationIds | boolean | query | Nej | |
| parentId | string | query | Nej | |
| searchText | string | query | Nej | |
| hashTags | array | query | Nej | |
| userId | string | query | Nej | |
| customConfigStr | string | query | Nej | |
| afterCommentId | string | query | Nej | |
| beforeCommentId | string | query | Nej | |
| questionId | string | query | Nej | |
| questionValue | integer | query | Nej |
Svar
Returnerer: GetCommentsResponseWithPresencePublicComment
Eksempel

getCommentText 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Svar
Returnerer: PublicAPIGetCommentTextResponse
Eksempel

getCommentVoteUserNames 
Parametre
| Navn | Type | Placering | Krævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| dir | integer | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: GetCommentVoteUserNamesSuccessResponse
Eksempel

lockComment 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel

pinComment 
Parametre
| Name | Type | Location | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: ChangeCommentPinStatusResponse
Eksempel

saveComment 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| isLive | boolean | query | Nej | |
| doSpamCheck | boolean | query | Nej | |
| sendEmails | boolean | query | Nej | |
| populateNotifications | boolean | query | Nej |
Svar
Returnerer: APISaveCommentResponse
Eksempel

saveCommentsBulk 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| isLive | boolean | query | Nej | |
| doSpamCheck | boolean | query | Nej | |
| sendEmails | boolean | query | Nej | |
| populateNotifications | boolean | query | Nej |
Svar
Returnerer: [SaveCommentsBulkResponse]
Eksempel

setCommentText 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| editKey | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: PublicAPISetCommentTextResponse
Eksempel

translateComments 
Translaterer de givne kommentarer til widgetens sprog. Kun tilgængelig når den tilsvarende widget‑tilpasningsregel har Kommentaroversættelse indstillet til Automatisk eller Manuel.
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| sso | string | query | Nej | |
| locale | string | query | Nej |
Svar
Returns: CommentTranslationsResponse
Eksempel

unBlockUserFromComment 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Svar
Returnerer: UnblockSuccess
Eksempel

unFlagComment 
Parametre
| Navn | Type | Placering | Krævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nej | |
| anonUserId | string | query | Nej |
Svar
Returnerer: FlagCommentResponse
Eksempel

unLockComment 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| sso | string | query | No |
Svar
Returnerer: APIEmptyResponse
Eksempel

unPinComment 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: ChangeCommentPinStatusResponse
Eksempel

updateComment 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| contextUserId | string | query | Nej | |
| doSpamCheck | boolean | query | Nej | |
| isLive | boolean | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel

voteComment 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| sessionId | string | query | No | |
| sso | string | query | No |
Svar
Returnerer: VoteResponse
Eksempel

getCommentsForUser 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| 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 |
Response
Returnerer: GetCommentsForUserResponse
Eksempel

addDomainConfig 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: AddDomainConfigResponse
Eksempel

deleteDomainConfig 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| domain | string | path | Yes |
Svar
Returnerer: DeleteDomainConfigResponse
Eksempel

getDomainConfig 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| domain | string | path | Ja |
Svar
Returnerer: GetDomainConfigResponse
Eksempel

getDomainConfigs 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: GetDomainConfigsResponse
Eksempel

patchDomainConfig 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| domainToUpdate | string | path | Ja |
Svar
Returnerer: PatchDomainConfigResponse
Eksempel

putDomainConfig 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| domainToUpdate | string | path | Ja |
Response
Returnerer: PutDomainConfigResponse
Eksempel

createEmailTemplate 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: CreateEmailTemplateResponse
Eksempel

deleteEmailTemplate 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel

deleteEmailTemplateRenderError 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| errorId | string | path | Yes |
Svar
Returnerer: APIEmptyResponse
Eksempel

getEmailTemplate 
Parametre
| Navn | Type | Placering | Obligatorisk | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Returnerer: GetEmailTemplateResponse
Eksempel

getEmailTemplateDefinitions 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: GetEmailTemplateDefinitionsResponse
Eksempel

getEmailTemplateRenderErrors 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| skip | number | query | Nej |
Svar
Returnerer: GetEmailTemplateRenderErrorsResponse
Eksempel

getEmailTemplates 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nej |
Svar
Returnerer: GetEmailTemplatesResponse
Eksempel

renderEmailTemplate 
Parametre
| Navn | Type | Placering | Obligatorisk | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| locale | string | query | Nej |
Svar
Returnerer: RenderEmailTemplateResponse
Eksempel

updateEmailTemplate 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel

getEventLog 
req tenantId urlId userIdWS
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| userIdWS | string | query | Ja | |
| startTime | integer | query | Ja | |
| endTime | integer | query | Nej |
Svar
Returnerer: GetEventLogResponse
Eksempel

getGlobalEventLog 
req tenantId urlId userIdWS
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| userIdWS | string | query | Ja | |
| startTime | integer | query | Ja | |
| endTime | integer | query | Nej |
Svar
Returnerer: GetEventLogResponse
Eksempel

createFeedPost 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| broadcastId | string | query | No | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| skipDupCheck | boolean | query | No |
Respons
Returnerer: CreateFeedPostsResponse
Eksempel

createFeedPostPublic 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | sti | Ja | |
| broadcastId | string | forespørgsel | Nej | |
| sso | string | forespørgsel | Nej |
Svar
Returnerer: CreateFeedPostResponse
Eksempel

deleteFeedPostPublic 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postId | string | path | Ja | |
| broadcastId | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: DeleteFeedPostPublicResponse
Eksempel

getFeedPosts 
req tenantId afterId
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| afterId | string | query | Nej | |
| limit | integer | query | Nej | |
| tags | array | query | Nej |
Svar
Returnerer: GetFeedPostsResponse
Eksempel

getFeedPostsPublic 
req tenantId afterId
Parametre
| Navn | Type | Placering | Krævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| afterId | string | query | Nej | |
| limit | integer | query | Nej | |
| tags | array | query | Nej | |
| sso | string | query | Nej | |
| isCrawler | boolean | query | Nej | |
| includeUserInfo | boolean | query | Nej |
Svar
Returns: PublicFeedPostsResponse
Eksempel

getFeedPostsStats 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postIds | array | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: FeedPostsStatsResponse
Eksempel

getUserReactsPublic 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postIds | array | query | No | |
| sso | string | query | No |
Respons
Returnerer: UserReactsResponse
Eksempel

reactFeedPostPublic 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postId | string | path | Ja | |
| isUndo | boolean | query | Nej | |
| broadcastId | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: ReactFeedPostResponse
Eksempel

updateFeedPost 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel

updateFeedPostPublic 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postId | string | path | Ja | |
| broadcastId | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: CreateFeedPostResponse
Eksempel

flagCommentPublic 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| isFlagged | boolean | query | Yes | |
| sso | string | query | No |
Svar
Returnerer: APIEmptyResponse
Eksempel

getGifLarge 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| largeInternalURLSanitized | string | query | Ja |
Svar
Returnerer: GifGetLargeResponse
Eksempel

getGifsSearch 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| search | string | query | Ja | |
| locale | string | query | Nej | |
| rating | string | query | Nej | |
| page | number | query | Nej |
Respons
Returnerer: GetGifsSearchResponse
Eksempel

getGifsTrending 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| locale | string | query | No | |
| rating | string | query | No | |
| page | number | query | No |
Response
Returnerer: GetGifsTrendingResponse
Example

addHashTag 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | forespørgsel | Ja |
Svar
Returnerer: CreateHashTagResponse
Eksempel

addHashTagsBulk 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Svar
Returnerer: BulkCreateHashTagsResponse
Eksempel

deleteHashTag 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| tag | string | path | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel

getHashTags 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| page | number | query | Nej |
Svar
Returnerer: GetHashTagsResponse
Eksempel

patchHashTag 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| tag | string | path | Yes |
Svar
Returnerer: UpdateHashTagResponse
Eksempel

getMe 
Identificerer den anvendte legitimationsoplysning: den lejer den tilhører og, for OAuth‑tokens, brugeren der har autoriseret den.
Integrationer bruger dette til at teste en forbindelse og mærke den.
Parameters
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Response
Returnerer: GetMeResponse
Example

deleteModerationVote 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| voteId | string | path | Ja | |
| broadcastId | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: VoteDeleteResponse
Eksempel

getApiComments 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| page | number | query | Nej | |
| count | number | query | Nej | |
| text-search | string | query | Nej | |
| byIPFromComment | string | query | Nej | |
| filters | string | query | Nej | |
| searchFilters | string | query | Nej | |
| sorts | string | query | Nej | |
| demo | boolean | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: ModerationAPIGetCommentsResponse
Eksempel

getApiExportStatus 
Parametre
| Navn | Type | Placering | Obligatorisk | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| batchJobId | string | query | Nej | |
| sso | string | query | Nej |
Respons
Returnerer: ModerationExportStatusResponse
Eksempel

getApiIds 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| text-search | string | query | Nej | |
| byIPFromComment | string | query | Nej | |
| filters | string | query | Nej | |
| searchFilters | string | query | Nej | |
| afterId | string | query | Nej | |
| demo | boolean | query | Nej | |
| sso | string | query | Nej |
Respons
Returns: ModerationAPIGetCommentIdsResponse
Eksempel

getBanUsersFromComment 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: GetBannedUsersFromCommentResponse
Eksempel

getCommentBanStatus 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: GetCommentBanStatusResponse
Eksempel

getCommentChildren 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Svar
Returnerer: ModerationAPIChildCommentsResponse
Eksempel

getCount 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| text-search | string | query | Nej | |
| byIPFromComment | string | query | Nej | |
| filter | string | query | Nej | |
| searchFilters | string | query | Nej | |
| demo | boolean | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: ModerationAPICountCommentsResponse
Eksempel

getCounts 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: GetBannedUsersCountResponse
Eksempel

getLogs 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nej |
Response
Returnerer: ModerationAPIGetLogsResponse
Eksempel

getManualBadges 
Parametre
| Navn | Type | Placering | Obligatorisk | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: GetTenantManualBadgesResponse
Eksempel

getManualBadgesForUser 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgesUserId | string | query | No | |
| commentId | string | query | No | |
| sso | string | query | No |
Svar
Returnerer: GetUserManualBadgesResponse
Eksempel

getModerationComment 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| includeEmail | boolean | query | Nej | |
| includeIP | boolean | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: ModerationAPICommentResponse
Eksempel

getModerationCommentText 
Parameters
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Response
Returnerer: GetCommentTextResponse
Eksempel

getPreBanSummary 
Parameters
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| includeByUserIdAndEmail | boolean | query | No | |
| includeByIP | boolean | query | No | |
| includeByEmailDomain | boolean | query | No | |
| sso | string | query | No |
Response
Returns: PreBanSummary
Example

getSearchCommentsSummary 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sso | string | query | No |
Svar
Returnerer: ModerationCommentSearchResponse
Eksempel

getSearchPages 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| sso | string | query | No |
Svar
Returnerer: ModerationPageSearchResponse
Eksempel

getSearchSites 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| value | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: ModerationSiteSearchResponse
Eksempel

getSearchSuggest 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| text-search | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: ModerationSuggestResponse
Eksempel

getSearchUsers 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| sso | string | query | No |
Respons
Returns: ModerationUserSearchResponse
Eksempel

getTrustFactor 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: GetUserTrustFactorResponse
Eksempel

getUserBanPreference 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: APIModerateGetUserBanPreferencesResponse
Eksempel

getUserInternalProfile 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | No | |
| sso | string | query | No |
Svar
Returnerer: GetUserInternalProfileResponse
Eksempel

postAdjustCommentVotes 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: AdjustVotesResponse
Eksempel

postApiExport 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| text-search | string | query | Nej | |
| byIPFromComment | string | query | Nej | |
| filters | string | query | Nej | |
| searchFilters | string | query | Nej | |
| sorts | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: ModerationExportResponse
Eksempel

postBanUserFromComment 
Parametre
| Navn | Type | Placering | Obligatorisk | Beskrivelse |
|---|---|---|---|---|
| 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 |
Svar
Returnerer: BanUserFromCommentResult
Eksempel

postBanUserUndo 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel

postBulkPreBanSummary 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| includeByUserIdAndEmail | boolean | query | No | |
| includeByIP | boolean | query | No | |
| includeByEmailDomain | boolean | query | No | |
| sso | string | query | No |
Svar
Returnerer: BulkPreBanSummary
Eksempel

postCommentsByIds 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: ModerationAPIChildCommentsResponse
Eksempel

postFlagComment 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel

postRemoveComment 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Svar
Returnerer: PostRemoveCommentApiResponse
Eksempel

postRestoreDeletedComment 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel

postSetCommentApprovalStatus 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| approved | boolean | query | Nej | |
| broadcastId | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: SetCommentApprovedResponse
Eksempel

postSetCommentReviewStatus 
Parametre
| Navn | Type | Placering | Obligatorisk | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| reviewed | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Svar
Returnerer: APIEmptyResponse
Eksempel

postSetCommentSpamStatus 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| spam | boolean | query | No | |
| permNotSpam | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respons
Returnerer: APIEmptyResponse
Eksempel

postSetCommentText 
Parameters
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Nej | |
| sso | string | query | Nej |
Response
Returnerer: SetCommentTextResponse
Example

postUnFlagComment 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Svar
Returnerer: APIEmptyResponse
Eksempel

postVote 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| direction | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Svar
Returnerer: VoteResponse
Eksempel

putAwardBadge 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgeId | string | query | Yes | |
| userId | string | query | No | |
| commentId | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respons
Returnerer: AwardUserBadgeResponse
Eksempel

putCloseThread 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No |
Svar
Returnerer: APIEmptyResponse
Eksempel

putRemoveBadge 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgeId | string | query | Yes | |
| userId | string | query | No | |
| commentId | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Svar
Returnerer: RemoveUserBadgeResponse
Eksempel

putReopenThread 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel

setTrustFactor 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| trustFactor | string | query | No | |
| sso | string | query | No |
Svar
Returnerer: SetUserTrustFactorResponse
Eksempel

createModerator 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: CreateModeratorResponse
Eksempel

deleteModerator 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| sendEmail | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel

getModerator 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: GetModeratorResponse
Eksempel

getModerators 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | forespørgsel | Ja | |
| skip | number | forespørgsel | Nej |
Svar
Returnerer: GetModeratorsResponse
Eksempel

sendInvite 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| fromName | string | query | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel

updateModerator 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel

deleteNotificationCount 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel

getCachedNotificationCount 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: GetCachedNotificationCountResponse
Eksempel

getNotificationCount 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| urlId | string | query | No | |
| fromCommentId | string | query | No | |
| viewed | boolean | query | No | |
| type | string | query | No |
Respons
Returnerer: GetNotificationCountResponse
Eksempel

getNotifications 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nej | |
| urlId | string | query | Nej | |
| fromCommentId | string | query | Nej | |
| viewed | boolean | query | Nej | |
| type | string | query | Nej | |
| skip | number | query | Nej |
Svar
Returnerer: GetNotificationsResponse
Eksempel

updateNotification 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel

createV1PageReact 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| title | string | query | No | |
| sso | string | query | No |
Svar
Returnerer: CreateV1PageReact
Eksempel

createV2PageReact 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| id | string | query | Ja | |
| title | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: CreateV1PageReact
Eksempel

deleteV1PageReact 
Parameters
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No |
Response
Returnerer: CreateV1PageReact
Example

deleteV2PageReact 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| id | string | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: CreateV1PageReact
Eksempel

getV1PageLikes 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | Yes | |
| includeUserInfo | string | query | No | Når den er angivet, returnerer den brugerne, der har liket siden (avatarer og brugernavne). Kun "public" accepteres, hvilket udelader private profiler. |
Svar
Returnerer: GetV1PageLikes
Eksempel

getV2PageReacts 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No | |
| includeUserInfo | string | query | No | Når den er sat, returnerer den brugerne for hver react-id (avatarer og brugernavne). Kun "public" accepteres, hvilket udelader private profiler. |
Svar
Returnerer: GetV2PageReacts
Eksempel

getV2PageReactUsers 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| id | string | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: GetV2PageReactUsersResponse
Eksempel

addPage 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: AddPageAPIResponse
Eksempel

deletePage 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: DeletePageAPIResponse
Eksempel

getOfflineUsers 
Tidligere kommentatorer på siden, som IKKE er online i øjeblikket. Sorteret efter displayName. Brug denne efter du har opbrugt /users/online for at rendere et "Members"-afsnit. Cursor-paginering på commenterName: serveren gennemløber det partielle {tenantId, urlId, commenterName} indeks fra afterName fremad via $gt, uden $skip-omkostninger.
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | Sidens URL-identifikator (renset på serversiden). |
| afterName | string | query | Nej | Cursor: send nextAfterName fra det forrige svar. |
| afterUserId | string | query | Nej | Cursor tiebreaker: send nextAfterUserId fra det forrige svar. Påkrævet når afterName er angivet, så navneties ikke mister poster. |
Svar
Returnerer: PageUsersOfflineResponse
Eksempel

getOnlineUsers 
Aktuelt online‑visere af en side: personer, hvis websocketsession er abonneret på siden lige nu.
Returnerer anonCount + totalCount (rum‑omfattende abonnenter, inklusive anonyme seere, som vi ikke tæller).
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Side-URL-identifikator (ryddet server-side). |
| afterName | string | query | No | Markør: send nextAfterName fra den forrige respons. |
| afterUserId | string | query | No | Markør tie-breaker: send nextAfterUserId fra den forrige respons. Kræves når afterName er sat så navne-ties ikke dropper poster. |
Response
Returns: PageUsersOnlineResponse
Example

getPageByURLId 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja |
Respons
Returnerer: GetPageByURLIdAPIResponse
Eksempel

getPageLikes 
Like-tælling for en side, eventuelt med brugerne der har liket den.
Parameters
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja | |
| includeUserInfo | string | query | Nej | ""public" udelader brugere med private profiler, "include-private" inkluderer dem." |
Response
Returnerer: GetPageLikesAPIResponse
Example

getPageReacts 
Brugerdefinerede react-tællinger for en side, eventuelt med de brugere, der har reageret.
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja | |
| includeUserInfo | string | query | Nej | "public" udelader brugere med private profiler, "include-private" inkluderer dem. |
Svar
Returnerer: GetPageReactsAPIResponse
Eksempel

getPages 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: GetPagesAPIResponse
Eksempel

getPagesPublic 
List sider for en lejer. Brugt af FChat desktopklienten til at udfylde dens rumliste.
Kræver enableFChat skal være sand på den opløste brugerdefinerede konfiguration for hver side.
Sider, der kræver SSO, filtreres i forhold til den anmodende brugers gruppeadgang.
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| cursor | string | query | No | Uigennemsigtig pagineringsmarkør returneret som nextCursor fra en tidligere anmodning. Bundet til den samme sortBy. |
| limit | integer | query | No | 1..200, standard 50 |
| q | string | query | No | Valgfri case‑insensitiv titelpræfiksfilter. |
| sortBy | string | query | No | Sorteringsorden. updatedAt (standard, nyeste først), commentCount (fleste kommentarer først), eller title (alfabetisk). |
| hasComments | boolean | query | No | Hvis sand, returneres kun sider med mindst én kommentar. |
Svar
Returns: GetPublicPagesResponse
Eksempel

getUsersInfo 
Bulk-brugeroplysninger for en tenant. Givet userIds returneres visningsoplysninger fra User / SSOUser. Bruges af kommentar-widgeten til at berige brugere, der netop dukkede op via en presence-begivenhed. Ingen sidekontekst: privatliv håndhæves ensartet (private profiler er maskeret).
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| ids | string | query | Ja | Komma-adskilte userIds. |
Svar
Returnerer: PageUsersInfoResponse
Eksempel

migratePages 
Sætter et batch-job i kø, der flytter kommentarer, sider og relaterede poster fra én urlId eller et domæne til et andet. "urlId"-migreringer matcher kun den præcise urlId. "domain"-migreringer finder/erstatter værdien i hver urlId og url. Poll GET /api/v1/batch-jobs/{batchJobId}: når jobbet er færdigt, indeholder det resultater for hver migrering samt et undoId.
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: QueuePageMigrationJobAPIResponse
Eksempel

patchPage 
Parametre
| Navn | Type | Placering | Krævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: PatchPageAPIResponse
Eksempel

undoPageMigrations 
Sætter et batch-job i kø, der tilbagefører hver migration fra ét migrate-pages-job, nyeste først. Tilgængeligt i 90 dage. Poster, der er ændret siden migrationen, efterlades urørte, så en senere redigering aldrig overskrives. Poll GET /api/v1/batch-jobs/{batchJobId} for at se antallet af gendannede/sprungne over.
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| undoId | string | path | Ja |
Svar
Returnerer: QueuePageMigrationJobAPIResponse
Eksempel

deletePendingWebhookEvent 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel

getPendingWebhookEventCount 
Parametre
| 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 |
Svar
Returnerer: GetPendingWebhookEventCountResponse
Eksempel

getPendingWebhookEvents 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | query | Nej | |
| externalId | string | query | Nej | |
| eventType | string | query | Nej | |
| type | string | query | Nej | |
| domain | string | query | Nej | |
| attemptCountGT | number | query | Nej | |
| skip | number | query | Nej |
Svar
Returnerer: GetPendingWebhookEventsResponse
Eksempel

createPollVote 
Registrer en stemme i en afstemning, eller flyt en eksisterende til en anden mulighed. En vælger har højst én stemme pr. afstemning, så hvis du kalder dette igen for den samme vælger, flyttes deres stemme i stedet for at tilføje en.
Dette overholder sidens afstemningsindstillinger: hvis afstemning kun er tilladt for loggede brugere, afvises en stemme kun med et anonUserId, og anonyme stemmer er hastighedsbegrænsede pr. IP pr. afstemning.
Parameters
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Response
Returnerer: CreatePollVoteResponse
Example

deletePollVote 
Retract a vote. The option it was cast on gives its tally back.
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returns: DeletePollVoteResponse
Eksempel

getPollVote 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Svar
Returns: GetPollVoteResponse
Eksempel

getPollVotes 
The individual votes behind one poll's tallies, oldest first.
En afstemning tilhører en kommentar, så stemmer læses altid én afstemning ad gangen - commentId er påkrævet. Det holder hver forespørgsel på de indekser, som samlingen allerede har.
Overholder afstemningens privatliv: en anonym afstemnings stemmer kan ikke læses (poll-anonymous), her eller via id.
Parameters
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | query | Ja | |
| voterId | string | query | Nej | |
| optionId | string | query | Nej | |
| skip | integer | query | Nej |
Svar
Returnerer: GetPollVotesResponse
Eksempel

deletePoll 
Remove en afstemning fra dens kommentar, sammen med hver stemme afgivet på den. Kommentaren selv forbliver uændret.
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel

getPoll 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes |
Svar
Returnerer: GetPollResponse
Eksempel

getPollVoters 
Who voted for which option. Anonymous polls never answer, admins-only polls answer only for an admin or moderator.
Parameters
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| urlId | string | query | No | |
| page | integer | query | No | |
| search | string | query | No | |
| sso | string | query | No |
Response
Returnerer: GetPollVoterNamesSuccessResponse
Example

patchPoll 
Edit en afstemning på stedet, mens du bevarer stemmetal: ændr spørgsmålet, omdøb en mulighed, luk eller genåbn den, eller ændr hvem der må se vælgerne. Mulighederne adresseres via id - for at tilføje, fjerne eller omarrangere dem, PUT den fulde liste.
Parameters
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja |
Svar
Returnerer: SavePollResponse
Eksempel

putPoll 
Vedhæft en afstemning til en kommentar, eller angiv den fulde tilstand for den afstemning, den allerede har.
Indstillinger matches efter id: en indstilling sendt med id'et for en eksisterende indstilling bevarer sine stemmer (og får den nye etiket og position), en indstilling sendt uden id tilføjes, og eksisterende indstillinger, der udelades fra listen, fjernes sammen med de afgivne stemmer på dem.
Hvis man ikke beholder nogen eksisterende indstillings-id'er på en afstemning, der har stemmer, slettes alle af dem, så det kræver replaceVotes=true.
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| replaceVotes | boolean | query | Nej |
Svar
Returnerer: SavePollResponse
Eksempel

votePoll 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| urlId | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Svar
Returnerer: VotePollResponse
Eksempel

createQuestionConfig 
Parameters
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Response
Returnerer: CreateQuestionConfigResponse
Example

deleteQuestionConfig 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel

getQuestionConfig 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Svar
Returnerer: GetQuestionConfigResponse
Eksempel

getQuestionConfigs 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nej |
Svar
Returnerer: GetQuestionConfigsResponse
Eksempel

updateQuestionConfig 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel

createQuestionResult 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: CreateQuestionResultResponse
Eksempel

deleteQuestionResult 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel

getQuestionResult 
Parametre
| Navn | Type | Location | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: GetQuestionResultResponse
Eksempel

getQuestionResults 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Nej | |
| userId | string | query | Nej | |
| startDate | string | query | Nej | |
| questionId | string | query | Nej | |
| questionIds | string | query | Nej | |
| skip | number | query | Nej |
Respons
Returnerer: GetQuestionResultsResponse
Eksempel

updateQuestionResult 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Svar
Returns: APIEmptyResponse
Eksempel

aggregateQuestionResults 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| questionId | string | query | Nej | |
| questionIds | array | query | Nej | |
| urlId | string | query | Nej | |
| timeBucket | string | query | Nej | |
| startDate | string | query | Nej | |
| forceRecalculate | boolean | query | Nej |
Svar
Returnerer: AggregateQuestionResultsResponse
Eksempel

bulkAggregateQuestionResults 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| forceRecalculate | boolean | query | Nej |
Svar
Returnerer: BulkAggregateQuestionResultsResponse
Eksempel

combineCommentsWithQuestionResults 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | forespørgsel | Ja | |
| questionId | string | forespørgsel | Nej | |
| questionIds | array | forespørgsel | Nej | |
| urlId | string | forespørgsel | Nej | |
| startDate | string | forespørgsel | Nej | |
| forceRecalculate | boolean | forespørgsel | Nej | |
| minValue | number | forespørgsel | Nej | |
| maxValue | number | forespørgsel | Nej | |
| limit | number | forespørgsel | Nej |
Svar
Returnerer: CombineQuestionResultsWithCommentsResponse
Eksempel

addSSOUser 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: AddSSOUserAPIResponse
Eksempel

deleteSSOUser 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| deleteComments | boolean | query | Nej | |
| commentDeleteMode | string | query | Nej |
Svar
Returnerer: DeleteSSOUserAPIResponse
Eksempel

getSSOUserByEmail 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| string | path | Yes |
Respons
Returnerer: GetSSOUserByEmailAPIResponse
Eksempel

getSSOUserById 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: GetSSOUserByIdAPIResponse
Eksempel

getSSOUsers 
Parametre
| Name | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | integer | query | Nej |
Svar
Returnerer: GetSSOUsersResponse
Eksempel

patchSSOUser 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| updateComments | boolean | query | Nej |
Svar
Returnerer: PatchSSOUserAPIResponse
Eksempel

putSSOUser 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| updateComments | boolean | query | Nej |
Svar
Returnerer: PutSSOUserAPIResponse
Eksempel

createSubscription 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: CreateSubscriptionAPIResponse
Eksempel

deleteSubscription 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nej |
Svar
Returnerer: DeleteSubscriptionAPIResponse
Eksempel

getSubscriptions 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nej |
Svar
Returnerer: GetSubscriptionsAPIResponse
Eksempel

updateSubscription 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nej |
Svar
Returnerer: UpdateSubscriptionAPIResponse
Eksempel

getTenantDailyUsages 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| yearNumber | number | query | Nej | |
| monthNumber | number | query | Nej | |
| dayNumber | number | query | Nej | |
| skip | number | query | Nej |
Svar
Returnerer: GetTenantDailyUsagesResponse
Eksempel

createTenantPackage 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Svar
Returnerer: CreateTenantPackageResponse
Eksempel

deleteTenantPackage 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel

getTenantPackage 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Respons
Returnerer: GetTenantPackageResponse
Eksempel

getTenantPackages 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nej |
Svar
Returnerer: GetTenantPackagesResponse
Eksempel

replaceTenantPackage 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Returnerer: APIEmptyResponse
Eksempel

updateTenantPackage 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel

createTenantUser 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: CreateTenantUserResponse
Eksempel

deleteTenantUser 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| deleteComments | string | query | Nej | |
| commentDeleteMode | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel

getTenantUser 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Returnerer: GetTenantUserResponse
Eksempel

getTenantUsers 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nej |
Svar
Returnerer: GetTenantUsersResponse
Eksempel

replaceTenantUser 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| updateComments | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel

sendLoginLink 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| redirectURL | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel

updateTenantUser 
Parametre
| Navn | Type | Location | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| updateComments | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel

createTenant 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Svar
Returnerer: CreateTenantResponse
Eksempel

deleteTenant 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| sure | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel

getTenant 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: GetTenantResponse
Eksempel

getTenants 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| meta | string | query | No | |
| skip | number | query | No |
Svar
Returnerer: GetTenantsResponse
Eksempel

updateTenant 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel

changeTicketState 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: ChangeTicketStateResponse
Eksempel

createTicket 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Ja |
Respons
Returnerer: CreateTicketResponse
Eksempel

getTicket 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nej |
Svar
Returnerer: GetTicketResponse
Eksempel

getTickets 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| state | number | query | No | |
| skip | number | query | No | |
| limit | number | query | No |
Respons
Returnerer: GetTicketsResponse
Eksempel

getTranslations 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| namespace | string | path | Ja | |
| component | string | path | Ja | |
| locale | string | query | Nej | |
| useFullTranslationIds | boolean | query | Nej |
Svar
Returnerer: GetTranslationsResponse
Eksempel

uploadImage 
Upload og ændre størrelse på et billede
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| sizePreset | string | query | No | Størrelsesforudindstilling: "Default" (1000x1000px) eller "CrossPlatform" (opretter størrelser for populære enheder) |
| urlId | string | query | No | side-id, som uploaden sker fra, for at konfigurere |
Svar
Returns: UploadImageResponse
Eksempel

getUserBadgeProgressById 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIGetUserBadgeProgressResponse
Eksempel

getUserBadgeProgressByUserId 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | path | Ja |
Svar
Returnerer: APIGetUserBadgeProgressResponse
Eksempel

getUserBadgeProgressList 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| limit | number | query | No | |
| skip | number | query | No |
Svar
Returns: APIGetUserBadgeProgressListResponse
Eksempel

createUserBadge 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: APICreateUserBadgeResponse
Eksempel

deleteUserBadge 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIEmptySuccessResponse
Eksempel

getUserBadge 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Returnerer: APIGetUserBadgeResponse
Eksempel

getUserBadges 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nej | |
| badgeId | string | query | Nej | |
| type | number | query | Nej | |
| displayedOnComments | boolean | query | Nej | |
| limit | number | query | Nej | |
| skip | number | query | Nej |
Svar
Returnerer: APIGetUserBadgesResponse
Eksempel

updateUserBadge 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIEmptySuccessResponse
Eksempel

getUserNotificationCount 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: GetUserNotificationCountResponse
Eksempel

getUserNotifications 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | No | Brugt til at bestemme, om den aktuelle side er abonneret på. |
| 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 |
Svar
Returnerer: GetMyNotificationsResponse
Eksempel

resetUserNotificationCount 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: ResetUserNotificationsResponse
Eksempel

resetUserNotifications 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| afterId | string | query | Nej | |
| afterCreatedAt | integer | query | Nej | |
| unreadOnly | boolean | query | Nej | |
| dmOnly | boolean | query | Nej | |
| noDm | boolean | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: ResetUserNotificationsResponse
Eksempel

updateUserNotificationCommentSubscriptionStatus 
Aktivér eller deaktiver notifikationer for en specifik kommentar.
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| notificationId | string | path | Ja | |
| optedInOrOut | string | path | Ja | |
| commentId | string | query | Ja | |
| sso | string | query | Nej |
Respons
Returnerer: UpdateUserNotificationCommentSubscriptionStatusResponse
Eksempel

updateUserNotificationPageSubscriptionStatus 
Aktivér eller deaktiver notifikationer for en side. Når brugere er tilmeldt en side, oprettes der notifikationer for nye overordnede kommentarer, og også
Parametre
| Navn | Type | Location | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja | |
| url | string | query | Ja | |
| pageTitle | string | query | Ja | |
| subscribedOrUnsubscribed | string | path | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: UpdateUserNotificationPageSubscriptionStatusResponse
Eksempel

updateUserNotificationStatus 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| notificationId | string | path | Ja | |
| newStatus | string | path | Ja | |
| sso | string | query | Nej |
Respons
Returnerer: UpdateUserNotificationStatusResponse
Eksempel

getUserPresenceStatuses 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlIdWS | string | query | Ja | |
| userIds | string | query | Ja |
Svar
Returnerer: GetUserPresenceStatusesResponse
Eksempel

searchUsers 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| usernameStartsWith | string | query | Nej | |
| mentionGroupIds | array | query | Nej | |
| sso | string | query | Nej | |
| searchSection | string | query | Nej |
Svar
Returnerer: SearchUsersResult
Eksempel

getUser 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Returnerer: GetUserResponse
Eksempel

createVote 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | query | Ja | |
| direction | string | query | Ja | |
| userId | string | query | Nej | |
| anonUserId | string | query | Nej |
Svar
Returnerer: VoteResponse
Eksempel

deleteVote 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| editKey | string | query | No |
Respons
Returnerer: VoteDeleteResponse
Eksempel

getVotes 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja |
Respons
Returnerer: GetVotesResponse
Eksempel

getVotesForUser 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Svar
Returnerer: GetVotesForUserResponse
Eksempel

createWebhook 
Abonnerer på en URL til en kommentar‑hændelse (REST‑hook‑abonnement). At abonnere den samme URL på den samme hændelse og domæne igen returnerer det eksisterende abonnement. Leverancer er HMAC‑signeret, se webhooks‑guiden; den ældre token‑header sendes aldrig til API‑abonnementer.
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Returnerer: CreateWebhookResponse
Eksempel

deleteWebhook 
Unsubscribes (REST hook unsubscribe). Kun abonnementer oprettet gennem dette API kan slettes her; webhooks administreret via dashboardet redigeres i dashboardet.
Parameters
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Response
Returnerer: APIEmptyResponse
Eksempel

getWebhooks 
Lister de webhooks, der er konfigureret for lejeren, både dashboard‑styrede rækker og API‑abonnementer.
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| event | string | query | Nej | |
| domain | string | query | Nej | |
| source | string | query | Nej | |
| skip | number | query | Nej |
Svar
Returnerer: GetWebhooksResponse
Eksempel

getWebhookSamplePayloads 
Seneste kommentarer i præcis den form, som webhook-leverancer bruger, til at bygge integrationer (for eksempel Zapier‑eksempeldata). Hver begivenhed leverer det samme kommentarobjekt, så event kun behøver at være gyldig.
Parameters
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| event | string | query | No | |
| limit | number | query | No |
Svar
Returnerer: GetWebhookSamplePayloadsResponse
Example

Brug for hjælp?
Hvis du støder på problemer eller har spørgsmål om Swift SDK'et, så:
Bidrag
Bidrag er velkomne! Besøg venligst GitHub-repositoriet for retningslinjer for bidrag.