
Idioma 🇧🇷 Português (Brasil)
Documentação
Introdução
Referência API
Inquilinos de Agente
Agregação
Logs de Auditoria
Autenticação
Jobs em Lote
Bloquear do Comentário
Verificar Comentários Bloqueados
Comentários
Comentários Para Usuário
Configurações de Domínio
Modelos de Email
Log de Eventos
Publicações no Feed
Denunciar Comentário
GIFs
Hashtags
Eu
Moderação
Moderadores
Contagem de Notificações
Notificações
Reações de Página
Páginas
Eventos de Webhook Pendentes
Votos de Enquete
Enquetes
Configurações de Pergunta
Resultados de Pergunta
Agregação de Resultados de Pergunta
Usuários SSO
Assinaturas
Uso Diário do Inquilino
Pacotes de Inquilino
Usuários do Inquilino
Inquilinos
Tickets
Traduções
Carregar Imagem
Progresso de Emblema de Usuário
Emblemas de Usuário
Notificações de Usuário
Status de Presença do Usuário
Busca de Usuário
Usuários
Votos
Webhooks
FastComments SDK Swift
Este é o SDK oficial em Swift para o FastComments.
SDK oficial em Swift para a API do FastComments
Repositório
Agentes de codificação IA 
Forneça ao seu agente de codificação o contexto do FastComments que ele precisa - widgets, configuração, Secure SSO, a REST API e os SDKs:
npx skills add fastcomments/skills
Funciona com Claude Code, Codex, Cursor, Copilot, Gemini e todos os outros agentes que o skills CLI suporta.
Instalação 
Swift Package Manager
Adicione o seguinte ao seu arquivo Package.swift:
dependencies: [
.package(url: "https://github.com/fastcomments/fastcomments-swift.git", from: "3.1.2")
]
Ou no Xcode:
- File > Add Packages...
- Insira a URL do repositório:
https://github.com/fastcomments/fastcomments-swift.git - Selecione a versão que deseja usar
Requisitos
- Swift 5.9+
- iOS 13.0+ / macOS 10.15+ / tvOS 13.0+ / watchOS 6.0+
Conteúdo da Biblioteca 
O SDK FastComments Swift consiste em vários módulos:
-
Client Module - Cliente de API para as REST APIs do FastComments
- Definições completas de tipos para todos os modelos de API
- Métodos autenticados (
DefaultAPI), públicos (PublicAPI) e de moderação (ModerationAPI) - Suporte completo a async/await
- Veja client/README.md para documentação detalhada da API
-
SSO Module - Utilitários de Single Sign-On do lado do servidor
- Geração segura de tokens para autenticação de usuários
- Suporte para modos SSO simples e seguro
- Assinatura de token baseada em HMAC-SHA256 usando CryptoKit
Início Rápido 
Usando a API Pública
import FastCommentsSwift
// Buscar comentários para uma página
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)")
}
Usando a API Autenticada
import FastCommentsSwift
// Configure sua chave de API na configuração compartilhada (enviada como o cabeçalho x-api-key)
FastCommentsSwiftAPIConfiguration.shared.customHeaders["x-api-key"] = "your-api-key"
// Buscar comentários usando a API autenticada
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)")
}
Usando a API de Moderação
import FastCommentsSwift
// Métodos de moderação são autorizados com um token `sso` para o moderador atuante
// (gere-o com FastCommentsSSO, veja a seção SSO acima).
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)")
}
Usando SSO para Autenticação
SSO Seguro (Recomendado para Produção)
import FastCommentsSwift
let apiKey = "your-api-key"
// Criar dados de usuário SSO seguros (apenas no lado do servidor!)
let userData = SecureSSOUserData(
id: "user-123", // ID do Usuário
email: "user@example.com", // Email
username: "johndoe", // Nome de usuário
avatar: "https://example.com/avatar.jpg" // URL do avatar
)
// Gerar token SSO
do {
let sso = try FastCommentsSSO.createSecure(apiKey: apiKey, secureSSOUserData: userData)
let token = try sso.createToken()
print("SSO Token: \(token ?? "")")
// Passe este token ao seu front-end para autenticação
} catch {
print("Error creating SSO token: \(error)")
}
SSO Simples (Para Desenvolvimento/Testes)
import FastCommentsSwift
// Criar dados de usuário SSO simples (não é necessária chave de API)
let userData = SimpleSSOUserData(
username: "johndoe",
email: "user@example.com",
avatar: "https://example.com/avatar.jpg"
)
// Gerar token SSO simples
let sso = FastCommentsSSO.createSimple(simpleSSOUserData: userData)
do {
let token = try sso.createToken()
print("Simple SSO Token: \(token ?? "")")
} catch {
print("Error creating SSO token: \(error)")
}
Clientes API 
O FastComments SDK fornece três clientes de API:
PublicAPI - Métodos Seguros para Cliente
A PublicAPI contém métodos que são seguros para chamar a partir de código cliente (apps iOS/macOS). Esses métodos:
- Não exigem uma chave de API
- Podem usar tokens SSO para autenticação
- São limitados por taxa por usuário/dispositivo
- São adequados para aplicações voltadas ao usuário final
Caso de uso: Buscar e criar comentários no seu app iOS
DefaultAPI - Métodos Lado do Servidor
A DefaultAPI contém métodos autenticados que exigem uma chave de API. Esses métodos:
- Exigem sua chave de API FastComments
- Devem SER CHAMADOS SOMENTE a partir de código do lado do servidor
- Fornecem acesso total aos seus dados FastComments
- São limitados por taxa por locatário
Caso de uso: Operações administrativas, exportação em massa de dados, gerenciamento de usuários
ModerationAPI - Métodos do Painel de Moderação
A ModerationAPI fornece um amplo conjunto de APIs de moderação ao vivo e rápidas. Cada método ModerationAPI aceita um parâmetro sso e pode autenticar via SSO ou um cookie de sessão FastComments.com.
Caso de uso: Construir uma experiência de moderação para moderadores da sua comunidade
IMPORTANTE: Nunca exponha sua chave de API no código cliente. As chaves de API devem ser usadas apenas no lado do servidor.
Fazendo Chamadas API 
O SDK Swift usa a sintaxe moderna async/await para todas as chamadas de API:
let response = try await PublicAPI.getCommentsPublic(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
Problemas Comuns 
Erros 401 Não Autorizado
Se você estiver recebendo erros 401 ao usar a API autenticada:
- Verifique sua chave de API: Certifique‑se de que está usando a chave de API correta do seu painel do FastComments
- Verifique o ID do tenant: Certifique‑se de que o ID do tenant corresponde à sua conta
- Formato da chave de API: A chave de API deve ser definida como o cabeçalho
x-api-keyna configuração compartilhada:
FastCommentsSwiftAPIConfiguration.shared.customHeaders["x-api-key"] = "YOUR_API_KEY"
- Usando a API errada: Certifique‑se de que está usando
DefaultAPI(nãoPublicAPI) para chamadas autenticadas
Problemas com Token SSO
Se os tokens SSO não estiverem funcionando:
- Use modo seguro em produção: Sempre use
FastCommentsSSO.createSecure()com sua chave de API para produção - Somente no lado do servidor: Gere tokens SSO seguros no seu servidor, nunca exponha sua chave de API aos clientes
- Verifique os dados do usuário: Certifique‑se de que todos os campos obrigatórios (id, email, nome de usuário) foram fornecidos
- Expiração do token: Tokens SSO seguros incluem um carimbo de tempo e podem expirar. Gere novos tokens conforme necessário.
Erros SSL/TLS
Se você encontrar erros SSL/TLS:
- Certifique‑se de que o Info.plist do seu app permite conexões HTTPS para fastcomments.com
- Verifique se você não está usando exceções do App Transport Security que possam bloquear a conexão.
Notas 
IDs de Broadcast
Você verá que deve passar um broadcastId em algumas chamadas de API. Quando receber eventos, você obterá esse ID de volta, para que saiba ignorar o evento se planeja aplicar alterações de forma otimista no cliente (o que você provavelmente vai querer fazer, já que oferece a melhor experiência). Passe um UUID aqui. O ID deve ser suficientemente único para não ocorrer duas vezes em uma sessão.
let broadcastId = UUID().uuidString
createAgentTenant 
Cria uma nova conta de teste para um agente de IA sem necessidade de cadastro humano. Não é necessária uma chave de API para chamar isso.
A resposta contém o ID do locatário, uma chave de API que funciona imediatamente contra a API REST e o servidor MCP, e uma URL de reivindicação. Forneça a URL de reivindicação ao humano para quem você está trabalhando: ao abri‑la enquanto estiver conectado ao FastComments, a conta será vinculada a ele. Contas não reivindicadas, e suas chaves, são excluídas 72 horas após a criação. Até serem reivindicadas, a conta tem os limites padrão de teste.
Resposta
Retorna: CreateAgentTenantResponse
Exemplo

aggregate 
Aggrega documentos agrupando-os (se groupBy for fornecido) e aplicando múltiplas operações.
Operações diferentes (por exemplo, sum, countDistinct, avg, etc.) são suportadas.
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| parentTenantId | string | query | Não | |
| includeStats | boolean | query | Não |
Resposta
Retorna: AggregateResponse
Exemplo

getAuditLogs 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | O tenant para ler logs de auditoria. |
| limit | integer | query | Não | Quantos logs retornar. Máximo 10000, padrão 1000. |
| skip | integer | query | Não | Quantos logs pular, para paginação. |
| order | string | query | Não | Direção de ordenação no horário do evento. Padrão DESC (mais recente primeiro). |
| after | integer | query | Não | |
| before | integer | query | Não | |
| username | string | query | Não | Retornar apenas eventos realizados por este nome de usuário. |
| ip | string | query | Não | Retornar apenas eventos deste endereço IP. |
| crudType | string | query | Não | Retornar apenas eventos deste tipo: c, r, u, d, ou login. |
| resourceName | string | query | Não | Retornar apenas eventos para este recurso, por exemplo User ou Moderator. |
| targetId | string | query | Não | Retornar apenas eventos cujo objeto afetado tem este id. |
| target | string | query | Não | Correspondência de substring sem distinção entre maiúsculas e minúsculas no rótulo do objeto afetado, por exemplo um nome de usuário ou email. |
| includeManagedTenants | boolean | query | Não | Também retornar eventos de tenants que este tenant gerencia. |
Resposta
Retorna: GetAuditLogsResponse
Exemplo

logoutPublic 
Resposta
Retorna: APIEmptyResponse
Exemplo

getBatchJob 
Status, progresso e, quando concluído, o resultado de um job em lote.
Parameters
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: GetBatchJobAPIResponse
Exemplo

getBatchJobs 
The tenant's batch jobs (imports, exports, page migrations...), newest first.
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| type | string | query | Não | Somente jobs deste tipo, por exemplo migrate-pages. |
| status | string | query | Não | Somente jobs neste status: requested, running, success ou failed. |
| skip | integer | query | Não | Quantos jobs pular, para paginação. |
Resposta
Retorna: GetBatchJobsAPIResponse
Exemplo

blockFromCommentPublic 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Resposta
Retorna: BlockSuccess
Exemplo

unBlockCommentPublic 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Resposta
Retorna: UnblockSuccess
Exemplo

checkedCommentsForBlocked 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| commentIds | string | query | Sim | Uma lista separada por vírgulas de ids de comentários. |
| sso | string | query | Não |
Resposta
Retorna: CheckBlockedCommentsResponse
Exemplo

blockUserFromComment 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim | |
| userId | string | query | Não | |
| anonUserId | string | query | Não |
Resposta
Retorna: BlockSuccess
Exemplo

createCommentPublic 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| sessionId | string | query | No | |
| sso | string | query | No | |
| locale | string | query | No |
Resposta
Retorna: SaveCommentsResponseWithPresence
Exemplo

deleteComment 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim | |
| contextUserId | string | query | Não | |
| isLive | boolean | query | Não |
Resposta
Retorna: DeleteCommentResult
Exemplo

deleteCommentPublic 
Parameters
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| commentId | string | path | Sim | |
| broadcastId | string | query | Sim | |
| editKey | string | query | Não | |
| sso | string | query | Não |
Response
Retorna: PublicAPIDeleteCommentResponse
Exemplo

deleteCommentVote 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| 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 |
Resposta
Retorna: VoteDeleteResponse
Exemplo

flagComment 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim | |
| userId | string | query | Não | |
| anonUserId | string | query | Não |
Resposta
Retorna: FlagCommentResponse
Exemplo

getComment 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: APIGetCommentResponse
Exemplo

getComments 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| page | integer | query | Não | |
| limit | integer | query | Não | |
| skip | integer | query | Não | |
| asTree | boolean | query | Não | |
| skipChildren | integer | query | Não | |
| limitChildren | integer | query | Não | |
| maxTreeDepth | integer | query | Não | |
| urlId | string | query | Não | |
| userId | string | query | Não | |
| anonUserId | string | query | Não | |
| contextUserId | string | query | Não | |
| hashTag | string | query | Não | |
| parentId | string | query | Não | |
| direction | string | query | Não | |
| fromDate | integer | query | Não | |
| toDate | integer | query | Não |
Resposta
Retorna: APIGetCommentsResponse
Exemplo

getCommentsPublic 
req tenantId urlId
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| urlId | string | query | Sim | |
| page | integer | query | Não | |
| direction | string | query | Não | |
| sso | string | query | Não | |
| skip | integer | query | Não | |
| skipChildren | integer | query | Não | |
| limit | integer | query | Não | |
| limitChildren | integer | query | Não | |
| countChildren | boolean | query | Não | |
| fetchPageForCommentId | string | query | Não | |
| includeConfig | boolean | query | Não | |
| countAll | boolean | query | Não | |
| includei10n | boolean | query | Não | |
| locale | string | query | Não | |
| modules | string | query | Não | |
| isCrawler | boolean | query | Não | |
| includeNotificationCount | boolean | query | Não | |
| asTree | boolean | query | Não | |
| maxTreeDepth | integer | query | Não | |
| useFullTranslationIds | boolean | query | Não | |
| parentId | string | query | Não | |
| searchText | string | query | Não | |
| hashTags | array | query | Não | |
| userId | string | query | Não | |
| customConfigStr | string | query | Não | |
| afterCommentId | string | query | Não | |
| beforeCommentId | string | query | Não | |
| questionId | string | query | Não | |
| questionValue | integer | query | Não |
Resposta
Retorna: GetCommentsResponseWithPresencePublicComment
Exemplo

getCommentText 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| commentId | string | path | Sim | |
| editKey | string | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: PublicAPIGetCommentTextResponse
Exemplo

getCommentVoteUserNames 
Parâmetros
| Nome | Tipo | Local | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| commentId | string | path | Sim | |
| dir | integer | query | Sim | |
| sso | string | query | Não |
Resposta
Retorna: GetCommentVoteUserNamesSuccessResponse
Exemplo

lockComment 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| commentId | string | path | Sim | |
| broadcastId | string | query | Sim | |
| sso | string | query | Não |
Resposta
Retorna: APIEmptyResponse
Exemplo

pinComment 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| commentId | string | path | Sim | |
| broadcastId | string | query | Sim | |
| sso | string | query | Não |
Resposta
Retorna: ChangeCommentPinStatusResponse
Exemplo

saveComment 
Parameters
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| sendEmails | boolean | query | No | |
| populateNotifications | boolean | query | No |
Resposta
Retorna: APISaveCommentResponse
Exemplo

saveCommentsBulk 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| sendEmails | boolean | query | No | |
| populateNotifications | boolean | query | No |
Resposta
Retorna: [SaveCommentsBulkResponse]
Exemplo

setCommentText 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| commentId | string | path | Sim | |
| broadcastId | string | query | Sim | |
| editKey | string | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: PublicAPISetCommentTextResponse
Exemplo

translateComments 
Traduz os comentários fornecidos para o idioma do widget. Disponível apenas quando a regra de personalização do widget correspondente tem a Tradução de Comentários configurada como Automática ou Manual.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No | |
| locale | string | query | No |
Response
Retorna: CommentTranslationsResponse
Example

unBlockUserFromComment 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim | |
| userId | string | query | Não | |
| anonUserId | string | query | Não |
Resposta
Retorna: UnblockSuccess
Exemplo

unFlagComment 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Resposta
Retorna: FlagCommentResponse
Exemplo

unLockComment 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| commentId | string | path | Sim | |
| broadcastId | string | query | Sim | |
| sso | string | query | Não |
Resposta
Retorna: APIEmptyResponse
Exemplo

unPinComment 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| commentId | string | path | Sim | |
| broadcastId | string | query | Sim | |
| sso | string | query | Não |
Resposta
Retorna: ChangeCommentPinStatusResponse
Exemplo

updateComment 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim | |
| contextUserId | string | query | Não | |
| doSpamCheck | boolean | query | Não | |
| isLive | boolean | query | Não |
Resposta
Retorna: APIEmptyResponse
Exemplo

voteComment 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| commentId | string | path | Sim | |
| urlId | string | query | Sim | |
| broadcastId | string | query | Sim | |
| sessionId | string | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: VoteResponse
Exemplo

getCommentsForUser 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| 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 |
Resposta
Retorna: GetCommentsForUserResponse
Exemplo

addDomainConfig 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim |
Resposta
Retorna: AddDomainConfigResponse
Exemplo

deleteDomainConfig 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| domain | string | path | Sim |
Resposta
Retorna: DeleteDomainConfigResponse
Exemplo

getDomainConfig 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| domain | string | path | Sim |
Resposta
Retorna: GetDomainConfigResponse
Exemplo

getDomainConfigs 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim |
Resposta
Retorna: GetDomainConfigsResponse
Exemplo

patchDomainConfig 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| domainToUpdate | string | path | Sim |
Resposta
Retorna: PatchDomainConfigResponse
Exemplo

putDomainConfig 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| domainToUpdate | string | path | Sim |
Resposta
Retorna: PutDomainConfigResponse
Exemplo

createEmailTemplate 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim |
Resposta
Retorna: CreateEmailTemplateResponse
Exemplo

deleteEmailTemplate 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: APIEmptyResponse
Exemplo

deleteEmailTemplateRenderError 
Parâmetros
| Nome | Tipo | Location | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim | |
| errorId | string | path | Sim |
Resposta
Retorna: APIEmptyResponse
Exemplo

getEmailTemplate 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: GetEmailTemplateResponse
Exemplo

getEmailTemplateDefinitions 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim |
Resposta
Retorna: GetEmailTemplateDefinitionsResponse
Exemplo

getEmailTemplateRenderErrors 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim | |
| skip | number | query | Não |
Resposta
Retorna: GetEmailTemplateRenderErrorsResponse
Exemplo

getEmailTemplates 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| skip | number | query | Não |
Resposta
Retorna: GetEmailTemplatesResponse
Exemplo

renderEmailTemplate 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| locale | string | query | Não |
Resposta
Retorna: RenderEmailTemplateResponse
Exemplo

updateEmailTemplate 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: APIEmptyResponse
Exemplo

getEventLog 
req tenantId urlId userIdWS
Parâmetros
| Nome | Tipo | Location | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| urlId | string | query | Sim | |
| userIdWS | string | query | Sim | |
| startTime | integer | query | Sim | |
| endTime | integer | query | Não |
Resposta
Retorna: GetEventLogResponse
Exemplo

getGlobalEventLog 
req tenantId urlId userIdWS
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| urlId | string | query | Sim | |
| userIdWS | string | query | Sim | |
| startTime | integer | query | Sim | |
| endTime | integer | query | Não |
Resposta
Retorna: GetEventLogResponse
Exemplo

createFeedPost 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| broadcastId | string | query | No | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| skipDupCheck | boolean | query | No |
Resposta
Retorna: CreateFeedPostsResponse
Exemplo

createFeedPostPublic 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| broadcastId | string | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: CreateFeedPostResponse
Exemplo

deleteFeedPostPublic 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| postId | string | path | Sim | |
| broadcastId | string | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: DeleteFeedPostPublicResponse
Exemplo

getFeedPosts 
req tenantId afterId
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| afterId | string | query | Não | |
| limit | integer | query | Não | |
| tags | array | query | Não |
Resposta
Retorna: GetFeedPostsResponse
Exemplo

getFeedPostsPublic 
req tenantId afterId
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| afterId | string | query | Não | |
| limit | integer | query | Não | |
| tags | array | query | Não | |
| sso | string | query | Não | |
| isCrawler | boolean | query | Não | |
| includeUserInfo | boolean | query | Não |
Resposta
Retorna: PublicFeedPostsResponse
Exemplo

getFeedPostsStats 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| postIds | array | query | Sim | |
| sso | string | query | Não |
Resposta
Retorna: FeedPostsStatsResponse
Exemplo

getUserReactsPublic 
Parameters
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postIds | array | query | No | |
| sso | string | query | No |
Response
Retorna: UserReactsResponse
Example

reactFeedPostPublic 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| isUndo | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Resposta
Retorna: ReactFeedPostResponse
Exemplo

updateFeedPost 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: APIEmptyResponse
Exemplo

updateFeedPostPublic 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| postId | string | path | Sim | |
| broadcastId | string | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: CreateFeedPostResponse
Exemplo

flagCommentPublic 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| commentId | string | path | Sim | |
| isFlagged | boolean | query | Sim | |
| sso | string | query | Não |
Resposta
Retorna: APIEmptyResponse
Exemplo

getGifLarge 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| largeInternalURLSanitized | string | query | Sim |
Resposta
Retorna: GifGetLargeResponse
Exemplo

getGifsSearch 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| search | string | query | Sim | |
| locale | string | query | Não | |
| rating | string | query | Não | |
| page | number | query | Não |
Resposta
Retorna: GetGifsSearchResponse
Exemplo

getGifsTrending 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| locale | string | query | Não | |
| rating | string | query | Não | |
| page | number | query | Não |
Resposta
Retorna: GetGifsTrendingResponse
Exemplo

addHashTag 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Response
Returns: CreateHashTagResponse
Example

addHashTagsBulk 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Resposta
Returns: BulkCreateHashTagsResponse
Exemplo

deleteHashTag 
Parâmetros
| Name | Type | Location | Obrigatório | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| tag | string | path | Sim |
Resposta
Retorna: APIEmptyResponse
Exemplo

getHashTags 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| page | number | query | Não |
Resposta
Retorna: GetHashTagsResponse
Exemplo

patchHashTag 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| tag | string | path | Sim |
Resposta
Retorna: UpdateHashTagResponse
Exemplo

getMe 
Identifica a credencial em uso: o tenant ao qual pertence e, para tokens OAuth, o usuário que a autorizou. Integrações usam isso para testar uma conexão e rotulá‑la.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim |
Response
Retorna: GetMeResponse
Example

deleteModerationVote 
Parameters
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| commentId | string | path | Sim | |
| voteId | string | path | Sim | |
| broadcastId | string | query | Não | |
| sso | string | query | Não |
Response
Retorna: VoteDeleteResponse
Example

getApiComments 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 |
Resposta
Returns: ModerationAPIGetCommentsResponse
Exemplo

getApiExportStatus 
Parameters
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| batchJobId | string | query | Não | |
| sso | string | query | Não |
Response
Returns: ModerationExportStatusResponse
Example

getApiIds 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| text-search | string | query | Não | |
| byIPFromComment | string | query | Não | |
| filters | string | query | Não | |
| searchFilters | string | query | Não | |
| afterId | string | query | Não | |
| demo | boolean | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: ModerationAPIGetCommentIdsResponse
Exemplo

getBanUsersFromComment 
Parameters
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| commentId | string | path | Sim | |
| sso | string | query | Não |
Response
Retorna: GetBannedUsersFromCommentResponse
Exemplo

getCommentBanStatus 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| commentId | string | path | Sim | |
| sso | string | query | Não |
Resposta
Retorna: GetCommentBanStatusResponse
Exemplo

getCommentChildren 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Resposta
Returns: ModerationAPIChildCommentsResponse
Exemplo

getCount 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filter | string | query | No | |
| searchFilters | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
Resposta
Retorna: ModerationAPICountCommentsResponse
Exemplo

getCounts 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Resposta
Retorna: GetBannedUsersCountResponse
Exemplo

getLogs 
Parameters
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| commentId | string | path | Sim | |
| sso | string | query | Não |
Response
Retorna: ModerationAPIGetLogsResponse
Example

getManualBadges 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| sso | string | query | Não |
Resposta
Retorna: GetTenantManualBadgesResponse
Exemplo

getManualBadgesForUser 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| badgesUserId | string | query | Não | |
| commentId | string | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: GetUserManualBadgesResponse
Exemplo

getModerationComment 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| includeEmail | boolean | query | No | |
| includeIP | boolean | query | No | |
| sso | string | query | No |
Resposta
Retorna: ModerationAPICommentResponse
Exemplo

getModerationCommentText 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| commentId | string | path | Sim | |
| sso | string | query | Não |
Resposta
Retorna: GetCommentTextResponse
Exemplo

getPreBanSummary 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| commentId | string | path | Sim | |
| includeByUserIdAndEmail | boolean | query | Não | |
| includeByIP | boolean | query | Não | |
| includeByEmailDomain | boolean | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: PreBanSummary
Exemplo

getSearchCommentsSummary 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| value | string | query | Não | |
| filters | string | query | Não | |
| searchFilters | string | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: ModerationCommentSearchResponse
Exemplo

getSearchPages 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| value | string | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: ModerationPageSearchResponse
Exemplo

getSearchSites 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| value | string | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: ModerationSiteSearchResponse
Exemplo

getSearchSuggest 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| sso | string | query | No |
Resposta
Retorna: ModerationSuggestResponse
Exemplo

getSearchUsers 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| value | string | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: ModerationUserSearchResponse
Exemplo

getTrustFactor 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| userId | string | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: GetUserTrustFactorResponse
Exemplo

getUserBanPreference 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| sso | string | query | Não |
Resposta
Retorna: APIModerateGetUserBanPreferencesResponse
Exemplo

getUserInternalProfile 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | No | |
| sso | string | query | No |
Resposta
Retorna: GetUserInternalProfileResponse
Exemplo

postAdjustCommentVotes 
Parameters
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| commentId | string | path | Sim | |
| broadcastId | string | query | Não | |
| sso | string | query | Não |
Response
Retorna: AdjustVotesResponse
Example

postApiExport 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| text-search | string | query | Não | |
| byIPFromComment | string | query | Não | |
| filters | string | query | Não | |
| searchFilters | string | query | Não | |
| sorts | string | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: ModerationExportResponse
Exemplo

postBanUserFromComment 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| commentId | string | path | Sim | |
| banEmail | boolean | query | Não | |
| banEmailDomain | boolean | query | Não | |
| banIP | boolean | query | Não | |
| deleteAllUsersComments | boolean | query | Não | |
| bannedUntil | string | query | Não | |
| isShadowBan | boolean | query | Não | |
| updateId | string | query | Não | |
| banReason | string | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: BanUserFromCommentResult
Exemplo

postBanUserUndo 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| sso | string | query | Não |
Resposta
Returns: APIEmptyResponse
Exemplo

postBulkPreBanSummary 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| includeByUserIdAndEmail | boolean | query | Não | |
| includeByIP | boolean | query | Não | |
| includeByEmailDomain | boolean | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: BulkPreBanSummary
Exemplo

postCommentsByIds 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Resposta
Retorna: ModerationAPIChildCommentsResponse
Exemplo

postFlagComment 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| commentId | string | path | Sim | |
| broadcastId | string | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: APIEmptyResponse
Exemplo

postRemoveComment 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| commentId | string | path | Sim | |
| broadcastId | string | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: PostRemoveCommentApiResponse
Exemplo

postRestoreDeletedComment 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| commentId | string | path | Sim | |
| broadcastId | string | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: APIEmptyResponse
Exemplo

postSetCommentApprovalStatus 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| commentId | string | path | Sim | |
| approved | boolean | query | Não | |
| broadcastId | string | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: SetCommentApprovedResponse
Exemplo

postSetCommentReviewStatus 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| commentId | string | path | Sim | |
| reviewed | boolean | query | Não | |
| broadcastId | string | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: APIEmptyResponse
Exemplo

postSetCommentSpamStatus 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| commentId | string | path | Sim | |
| spam | boolean | query | Não | |
| permNotSpam | boolean | query | Não | |
| broadcastId | string | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: APIEmptyResponse
Exemplo

postSetCommentText 
Parameters
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| commentId | string | path | Sim | |
| broadcastId | string | query | Não | |
| sso | string | query | Não |
Response
Retorna: SetCommentTextResponse
Exemplo

postUnFlagComment 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| commentId | string | path | Sim | |
| broadcastId | string | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: APIEmptyResponse
Exemplo

postVote 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| commentId | string | path | Sim | |
| direction | string | query | Não | |
| broadcastId | string | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: VoteResponse
Exemplo

putAwardBadge 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| badgeId | string | query | Sim | |
| userId | string | query | Não | |
| commentId | string | query | Não | |
| broadcastId | string | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: AwardUserBadgeResponse
Exemplo

putCloseThread 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| urlId | string | query | Sim | |
| sso | string | query | Não |
Resposta
Retorna: APIEmptyResponse
Exemplo

putRemoveBadge 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| badgeId | string | query | Sim | |
| userId | string | query | Não | |
| commentId | string | query | Não | |
| broadcastId | string | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: RemoveUserBadgeResponse
Exemplo

putReopenThread 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| urlId | string | query | Sim | |
| sso | string | query | Não |
Resposta
Retorna: APIEmptyResponse
Exemplo

setTrustFactor 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| userId | string | query | Não | |
| trustFactor | string | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: SetUserTrustFactorResponse
Exemplo

createModerator 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim |
Resposta
Retorna: CreateModeratorResponse
Exemplo

deleteModerator 
Parâmetros
| Nome | Tipo | Local | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim | |
| sendEmail | string | query | Não |
Resposta
Retorna: APIEmptyResponse
Exemplo

getModerator 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: GetModeratorResponse
Exemplo

getModerators 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| skip | number | query | Não |
Resposta
Retorna: GetModeratorsResponse
Exemplo

sendInvite 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim | |
| fromName | string | query | Sim |
Resposta
Retorna: APIEmptyResponse
Exemplo

updateModerator 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: APIEmptyResponse
Exemplo

deleteNotificationCount 
Parâmetros
| Nome | Tipo | Location | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: APIEmptyResponse
Exemplo

getCachedNotificationCount 
Parâmetros
| Nome | Tipo | Local | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: GetCachedNotificationCountResponse
Exemplo

getNotificationCount 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| urlId | string | query | No | |
| fromCommentId | string | query | No | |
| viewed | boolean | query | No | |
| type | string | query | No |
Resposta
Retorna: GetNotificationCountResponse
Exemplo

getNotifications 
Parameters
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| userId | string | query | Não | |
| urlId | string | query | Não | |
| fromCommentId | string | query | Não | |
| viewed | boolean | query | Não | |
| type | string | query | Não | |
| skip | number | query | Não |
Response
Retorna: GetNotificationsResponse
Exemplo

updateNotification 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim | |
| userId | string | query | Não |
Resposta
Retorna: APIEmptyResponse
Exemplo

createV1PageReact 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| urlId | string | query | Sim | |
| title | string | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: CreateV1PageReact
Exemplo

createV2PageReact 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| id | string | query | Yes | |
| title | string | query | No | |
| sso | string | query | No |
Resposta
Retorna: CreateV1PageReact
Exemplo

deleteV1PageReact 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| urlId | string | query | Sim | |
| sso | string | query | Não |
Resposta
Retorna: CreateV1PageReact
Exemplo

deleteV2PageReact 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| urlId | string | query | Sim | |
| id | string | query | Sim | |
| sso | string | query | Não |
Resposta
Retorna: CreateV1PageReact
Exemplo

getV1PageLikes 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| urlId | string | query | Sim | |
| sso | string | query | Não | |
| includeUserInfo | string | query | Não | Quando definido, retorna os usuários que curtiram a página (avatares e nomes de usuário). Apenas "public" é aceito, o que omite perfis privados. |
Resposta
Retorna: GetV1PageLikes
Exemplo

getV2PageReacts 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| urlId | string | query | Sim | |
| sso | string | query | Não | |
| includeUserInfo | string | query | Não | Quando definido, retorna os usuários para cada id de reação (avatares e nomes de usuário). Apenas "public" é aceito, o que omite perfis privados. |
Resposta
Retorna: GetV2PageReacts
Exemplo

getV2PageReactUsers 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| urlId | string | query | Sim | |
| id | string | query | Sim | |
| sso | string | query | Não |
Resposta
Retorna: GetV2PageReactUsersResponse
Exemplo

addPage 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim |
Resposta
Retorna: AddPageAPIResponse
Exemplo

deletePage 
Parâmetros
| Nome | Tipo | Local | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: DeletePageAPIResponse
Exemplo

getOfflineUsers 
Comentadores anteriores na página que NÃO estão atualmente online. Ordenados por displayName. Use isto após esgotar /users/online para renderizar uma seção "Members". Paginação por cursor em commenterName: o servidor percorre o índice parcial {tenantId, urlId, commenterName} a partir de afterName via $gt, sem custo de $skip.
Parâmetros
| Nome | Tipo | Local | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| urlId | string | query | Sim | Identificador da URL da página (limpo no servidor). |
| afterName | string | query | Não | Cursor: passe o nextAfterName da resposta anterior. |
| afterUserId | string | query | Não | Desempate do cursor: passe o nextAfterUserId da resposta anterior. Obrigatório quando afterName está definido para que empates de nome não descartem entradas. |
Resposta
Retorna: PageUsersOfflineResponse
Exemplo

getOnlineUsers 
Currently-online viewers of a page: people whose websocket session is subscribed to the page right now.
Visualizadores atualmente online de uma página: pessoas cuja sessão websocket está inscrita na página neste momento.
Returns anonCount + totalCount (room-wide subscribers, including anon viewers we don't enumerate).
Retorna anonCount + totalCount (assinantes de toda a sala, incluindo visualizadores anônimos que não enumeramos).
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Identificador da URL da página (limpo no servidor). |
| afterName | string | query | No | Cursor: passe nextAfterName da resposta anterior. |
| afterUserId | string | query | No | Desempate de cursor: passe nextAfterUserId da resposta anterior. Obrigatório quando afterName está definido para que empates de nome não removam entradas. |
Response
Returns: PageUsersOnlineResponse
Example

getPageByURLId 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| urlId | string | query | Sim |
Resposta
Retorna: GetPageByURLIdAPIResponse
Exemplo

getPageLikes 
Contagem de curtidas de uma página, opcionalmente com os usuários que curtiram.
Parâmetros
| Nome | Tipo | Local | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| urlId | string | query | Sim | |
| includeUserInfo | string | query | Não | "public" omite usuários com perfis privados, "include-private" os inclui. |
Resposta
Retorna: GetPageLikesAPIResponse
Exemplo

getPageReacts 
Contagens de reações personalizadas para uma página, opcionalmente com os usuários que reagiram.
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| urlId | string | query | Sim | |
| includeUserInfo | string | query | Não | ""public" omite usuários com perfis privados, "include-private" os inclui." |
Resposta
Retorna: GetPageReactsAPIResponse
Exemplo

getPages 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Resposta
Retorna: GetPagesAPIResponse
Exemplo

getPagesPublic 
Lista páginas para um tenant. Usada pelo cliente desktop FChat para popular sua lista de salas.
Requer que enableFChat seja true na configuração customizada resolvida para cada página.
Páginas que exigem SSO são filtradas de acordo com o acesso a grupos do usuário solicitante.
Parâmetros
| Nome | Tipo | Local | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| cursor | string | query | Não | Cursor opaco de paginação retornado como nextCursor de uma requisição anterior. Vinculado ao mesmo sortBy. |
| limit | integer | query | Não | 1..200, padrão 50 |
| q | string | query | Não | Filtro opcional de prefixo de título, sem diferenciar maiúsculas de minúsculas. |
| sortBy | string | query | Não | Ordem de classificação. updatedAt (padrão, mais recentes primeiro), commentCount (mais comentados primeiro) ou title (alfabética). |
| hasComments | boolean | query | Não | Se true, retorna apenas páginas com pelo menos um comentário. |
Resposta
Retorna: GetPublicPagesResponse
Exemplo

getUsersInfo 
Informações de usuários em lote para um tenant. Dados os userIds, retorna informações de exibição de User / SSOUser. Usado pelo widget de comentários para enriquecer usuários que acabaram de aparecer via um evento de presença. Sem contexto de página: a privacidade é aplicada de forma uniforme (perfis privados são mascarados).
Parâmetros
| Nome | Tipo | Local | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| ids | string | query | Sim | userIds delimitados por vírgula. |
Resposta
Retorna: PageUsersInfoResponse
Exemplo

migratePages 
Enfileira um job em lote que move comentários, páginas e registros relacionados de um urlId ou domínio para outro. Migrações de "urlId" correspondem apenas ao urlId exato. Migrações de "domain" localizam/substituem o valor dentro de cada urlId e url. Consulte GET /api/v1/batch-jobs/{batchJobId}: quando estiver concluído, ele conterá os resultados por migração e um undoId.
Parâmetros
| Nome | Tipo | Local | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim |
Resposta
Retorna: QueuePageMigrationJobAPIResponse
Exemplo

patchPage 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: PatchPageAPIResponse
Exemplo

undoPageMigrations 
Enfileira um trabalho em lote que reverte todas as migrações de um trabalho migrate-pages, da mais recente para a mais antiga. Disponível por 90 dias.
Registros alterados desde a migração são deixados como estão, de modo que uma edição posterior nunca seja sobrescrita.
Faça polling GET /api/v1/batch-jobs/{batchJobId} para obter as contagens de restaurados/ignorados.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| undoId | string | path | Yes |
Response
Retorna: QueuePageMigrationJobAPIResponse
Example

deletePendingWebhookEvent 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: APIEmptyResponse
Exemplo

getPendingWebhookEventCount 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| commentId | string | query | Não | |
| externalId | string | query | Não | |
| eventType | string | query | Não | |
| type | string | query | Não | |
| domain | string | query | Não | |
| attemptCountGT | number | query | Não |
Resposta
Retorna: GetPendingWebhookEventCountResponse
Exemplo

getPendingWebhookEvents 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| commentId | string | query | Não | |
| externalId | string | query | Não | |
| eventType | string | query | Não | |
| type | string | query | Não | |
| domain | string | query | Não | |
| attemptCountGT | number | query | Não | |
| skip | number | query | Não |
Resposta
Retorna: GetPendingWebhookEventsResponse
Exemplo

createPollVote 
Record a vote on a poll, or move an existing one to a different option. A voter has at most one vote per poll, so calling this again for the same voter moves their vote rather than adding one.
Registre um voto em uma enquete ou mova um voto existente para uma opção diferente. Um eleitor tem no máximo um voto por enquete, portanto chamar este endpoint novamente para o mesmo eleitor move seu voto em vez de adicionar um novo.
This obeys the site's poll settings: if voting is set to logged-in users only, a vote with just an anonUserId is rejected, and anonymous votes are rate limited per IP per poll.
Isso segue as configurações de enquete do site: se a votação estiver configurada apenas para usuários autenticados, um voto com apenas um anonUserId será rejeitado, e votos anônimos são limitados por taxa por IP por enquete.
Parameters
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Response
Retorna: CreatePollVoteResponse
Example

deletePollVote 
Retrair um voto. A opção na qual foi registrado devolve sua contagem.
Parameters
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Resposta
Retorna: DeletePollVoteResponse
Exemplo

getPollVote 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: GetPollVoteResponse
Exemplo

getPollVotes 
Os votos individuais por trás dos totais de uma enquete, do mais antigo para o mais recente.
Uma enquete pertence a um comentário, então os votos são sempre lidos uma enquete por vez - commentId é obrigatório. Isso mantém todas as consultas nos índices que a coleção já possui.
Obedece à privacidade da enquete: os votos de uma enquete anônima não podem ser lidos (poll-anonymous), aqui ou por id.
Parâmetros
| Nome | Tipo | Local | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| commentId | string | query | Sim | |
| voterId | string | query | Não | |
| optionId | string | query | Não | |
| skip | integer | query | Não |
Resposta
Retorna: GetPollVotesResponse
Exemplo

deletePoll 
Remova uma enquete do seu comentário, juntamente com todos os votos lançados nela. O próprio comentário permanece inalterado.
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| commentId | string | path | Sim |
Resposta
Retorna: APIEmptyResponse
Exemplo

getPoll 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| commentId | string | path | Sim |
Resposta
Retorna: GetPollResponse
Exemplo

getPollVoters 
Quem votou em qual opção. Enquetes anônimas nunca respondem, enquetes apenas para administradores respondem somente para um administrador ou moderador.
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| commentId | string | path | Sim | |
| urlId | string | query | Não | |
| page | integer | query | Não | |
| search | string | query | Não | |
| sso | string | query | Não |
Resposta
Returns: GetPollVoterNamesSuccessResponse
Exemplo

patchPoll 
Edite uma enquete no local, mantendo suas contagens: altere a pergunta, renomeie uma opção, feche ou reabra a enquete, ou mude quem pode ver os eleitores. As opções são endereçadas por id - para adicionar, remover ou reordená-las, faça PUT da lista completa.
Parâmetros
| Nome | Tipo | Local | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| commentId | string | path | Sim |
Resposta
Retorna: SavePollResponse
Exemplo

putPoll 
Anexar uma enquete a um comentário, ou definir o estado completo da enquete que já existe.
As opções são correspondidas por id: uma opção enviada com o id de uma opção existente mantém seus votos (e recebe o novo rótulo e posição), uma opção enviada sem id é adicionada, e opções existentes que não estão na lista são removidas juntamente com os votos lançados nelas.
Não manter nenhum id de opção existente em uma enquete que tem votos exclui todas elas, portanto isso requer replaceVotes=true.
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| commentId | string | path | Sim | |
| replaceVotes | boolean | query | Não |
Resposta
Retorna: SavePollResponse
Exemplo

votePoll 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| urlId | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Resposta
Retorna: VotePollResponse
Exemplo

createQuestionConfig 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim |
Resposta
Retorna: CreateQuestionConfigResponse
Exemplo

deleteQuestionConfig 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: APIEmptyResponse
Exemplo

getQuestionConfig 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: GetQuestionConfigResponse
Exemplo

getQuestionConfigs 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| skip | number | query | Não |
Resposta
Retorna: GetQuestionConfigsResponse
Exemplo

updateQuestionConfig 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Resposta
Retorna: APIEmptyResponse
Exemplo

createQuestionResult 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim |
Resposta
Retorna: CreateQuestionResultResponse
Exemplo

deleteQuestionResult 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: APIEmptyResponse
Exemplo

getQuestionResult 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: GetQuestionResultResponse
Exemplo

getQuestionResults 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| urlId | string | query | Não | |
| userId | string | query | Não | |
| startDate | string | query | Não | |
| questionId | string | query | Não | |
| questionIds | string | query | Não | |
| skip | number | query | Não |
Resposta
Retorna: GetQuestionResultsResponse
Exemplo

updateQuestionResult 
Parameters
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Response
Retorna: APIEmptyResponse
Example

aggregateQuestionResults 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| questionId | string | query | Não | |
| questionIds | array | query | Não | |
| urlId | string | query | Não | |
| timeBucket | string | query | Não | |
| startDate | string | query | Não | |
| forceRecalculate | boolean | query | Não |
Resposta
Retorna: AggregateQuestionResultsResponse
Exemplo

bulkAggregateQuestionResults 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| forceRecalculate | boolean | query | Não |
Resposta
Retorna: BulkAggregateQuestionResultsResponse
Exemplo

combineCommentsWithQuestionResults 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| questionId | string | query | Não | |
| questionIds | array | query | Não | |
| urlId | string | query | Não | |
| startDate | string | query | Não | |
| forceRecalculate | boolean | query | Não | |
| minValue | number | query | Não | |
| maxValue | number | query | Não | |
| limit | number | query | Não |
Resposta
Retorna: CombineQuestionResultsWithCommentsResponse
Exemplo

addSSOUser 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim |
Resposta
Retorna: AddSSOUserAPIResponse
Exemplo

deleteSSOUser 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim | |
| deleteComments | boolean | query | Não | |
| commentDeleteMode | string | query | Não |
Resposta
Retorna: DeleteSSOUserAPIResponse
Exemplo

getSSOUserByEmail 
Parâmetros
| Nome | Tipo | Local | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| string | path | Sim |
Resposta
Retorna: GetSSOUserByEmailAPIResponse
Exemplo

getSSOUserById 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: GetSSOUserByIdAPIResponse
Exemplo

getSSOUsers 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| skip | integer | query | Não |
Resposta
Retorna: GetSSOUsersResponse
Exemplo

patchSSOUser 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim | |
| updateComments | boolean | query | Não |
Resposta
Retorna: PatchSSOUserAPIResponse
Exemplo

putSSOUser 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim | |
| updateComments | boolean | query | Não |
Resposta
Retorna: PutSSOUserAPIResponse
Exemplo

createSubscription 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim |
Resposta
Retorna: CreateSubscriptionAPIResponse
Exemplo

deleteSubscription 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim | |
| userId | string | query | Não |
Resposta
Retorna: DeleteSubscriptionAPIResponse
Exemplo

getSubscriptions 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| userId | string | query | Não |
Resposta
Retorna: GetSubscriptionsAPIResponse
Exemplo

updateSubscription 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim | |
| userId | string | query | Não |
Resposta
Retorna: UpdateSubscriptionAPIResponse
Exemplo

getTenantDailyUsages 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| yearNumber | number | query | Não | |
| monthNumber | number | query | Não | |
| dayNumber | number | query | Não | |
| skip | number | query | Não |
Resposta
Retorna: GetTenantDailyUsagesResponse
Exemplo

createTenantPackage 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim |
Resposta
Retorna: CreateTenantPackageResponse
Exemplo

deleteTenantPackage 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: APIEmptyResponse
Exemplo

getTenantPackage 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: GetTenantPackageResponse
Exemplo

getTenantPackages 
Parâmetros
| Nome | Tipo | Local | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| skip | number | query | Não |
Resposta
Retorna: GetTenantPackagesResponse
Exemplo

replaceTenantPackage 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: APIEmptyResponse
Exemplo

updateTenantPackage 
Parâmetros
| Nome | Tipo | Local | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: APIEmptyResponse
Exemplo

createTenantUser 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim |
Resposta
Retorna: CreateTenantUserResponse
Exemplo

deleteTenantUser 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim | |
| deleteComments | string | query | Não | |
| commentDeleteMode | string | query | Não |
Resposta
Retorna: APIEmptyResponse
Exemplo

getTenantUser 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: GetTenantUserResponse
Exemplo

getTenantUsers 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| skip | number | query | Não |
Resposta
Retorna: GetTenantUsersResponse
Exemplo

replaceTenantUser 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim | |
| updateComments | string | query | Não |
Resposta
Retorna: APIEmptyResponse
Exemplo

sendLoginLink 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| redirectURL | string | query | No |
Resposta
Retorna: APIEmptyResponse
Exemplo

updateTenantUser 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| updateComments | string | query | No |
Resposta
Retorna: APIEmptyResponse
Exemplo

createTenant 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Resposta
Retorna: CreateTenantResponse
Exemplo

deleteTenant 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim | |
| sure | string | query | Não |
Resposta
Retorna: APIEmptyResponse
Exemplo

getTenant 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: GetTenantResponse
Exemplo

getTenants 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| meta | string | query | Não | |
| skip | number | query | Não |
Resposta
Retorna: GetTenantsResponse
Exemplo

updateTenant 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: APIEmptyResponse
Exemplo

changeTicketState 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| userId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: ChangeTicketStateResponse
Exemplo

createTicket 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| userId | string | query | Sim |
Resposta
Retorna: CreateTicketResponse
Exemplo

getTicket 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim | |
| userId | string | query | Não |
Resposta
Retorna: GetTicketResponse
Exemplo

getTickets 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| userId | string | query | Não | |
| state | number | query | Não | |
| skip | number | query | Não | |
| limit | number | query | Não |
Resposta
Retorna: GetTicketsResponse
Exemplo

getTranslations 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| namespace | string | path | Sim | |
| component | string | path | Sim | |
| locale | string | query | Não | |
| useFullTranslationIds | boolean | query | Não |
Resposta
Retorna: GetTranslationsResponse
Exemplo

uploadImage 
Upload and resize an image
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| sizePreset | string | query | Não | Size preset: "Default" (1000x1000px) ou "CrossPlatform" (cria tamanhos para dispositivos populares) |
| urlId | string | query | Não | ID da página de onde o upload está ocorrendo, para configurar |
Resposta
Returns: UploadImageResponse
Exemplo

getUserBadgeProgressById 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: APIGetUserBadgeProgressResponse
Exemplo

getUserBadgeProgressByUserId 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| userId | string | path | Sim |
Resposta
Retorna: APIGetUserBadgeProgressResponse
Exemplo

getUserBadgeProgressList 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| limit | number | query | No | |
| skip | number | query | No |
Resposta
Retorna: APIGetUserBadgeProgressListResponse
Exemplo

createUserBadge 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim |
Resposta
Retorna: APICreateUserBadgeResponse
Exemplo

deleteUserBadge 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: APIEmptySuccessResponse
Exemplo

getUserBadge 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Response
Retorna: APIGetUserBadgeResponse
Example

getUserBadges 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| badgeId | string | query | No | |
| type | number | query | No | |
| displayedOnComments | boolean | query | No | |
| limit | number | query | No | |
| skip | number | query | No |
Resposta
Retorna: APIGetUserBadgesResponse
Exemplo

updateUserBadge 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: APIEmptySuccessResponse
Exemplo

getUserNotificationCount 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| sso | string | query | Não |
Resposta
Retorna: GetUserNotificationCountResponse
Exemplo

getUserNotifications 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| urlId | string | query | Não | Usado para determinar se a página atual está subscrita. |
| pageSize | integer | query | Não | |
| afterId | string | query | Não | |
| includeContext | boolean | query | Não | |
| afterCreatedAt | integer | query | Não | |
| unreadOnly | boolean | query | Não | |
| dmOnly | boolean | query | Não | |
| noDm | boolean | query | Não | |
| includeTranslations | boolean | query | Não | |
| includeTenantNotifications | boolean | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: GetMyNotificationsResponse
Exemplo

resetUserNotificationCount 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| sso | string | query | Não |
Resposta
Retorna: ResetUserNotificationsResponse
Exemplo

resetUserNotifications 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| afterId | string | query | Não | |
| afterCreatedAt | integer | query | Não | |
| unreadOnly | boolean | query | Não | |
| dmOnly | boolean | query | Não | |
| noDm | boolean | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: ResetUserNotificationsResponse
Exemplo

updateUserNotificationCommentSubscriptionStatus 
Ativar ou desativar notificações para um comentário específico.
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| notificationId | string | path | Sim | |
| optedInOrOut | string | path | Sim | |
| commentId | string | query | Sim | |
| sso | string | query | Não |
Resposta
Retorna: UpdateUserNotificationCommentSubscriptionStatusResponse
Exemplo

updateUserNotificationPageSubscriptionStatus 
Ativa ou desativa notificações para uma página. Quando usuários estão inscritos em uma página, notificações são criadas para novos comentários raiz, e também
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| urlId | string | query | Sim | |
| url | string | query | Sim | |
| pageTitle | string | query | Sim | |
| subscribedOrUnsubscribed | string | path | Sim | |
| sso | string | query | Não |
Resposta
Retorna: UpdateUserNotificationPageSubscriptionStatusResponse
Exemplo

updateUserNotificationStatus 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| notificationId | string | path | Sim | |
| newStatus | string | path | Sim | |
| sso | string | query | Não |
Resposta
Retorna: UpdateUserNotificationStatusResponse
Exemplo

getUserPresenceStatuses 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| urlIdWS | string | query | Sim | |
| userIds | string | query | Sim |
Resposta
Retorna: GetUserPresenceStatusesResponse
Exemplo

searchUsers 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| urlId | string | query | Sim | |
| usernameStartsWith | string | query | Não | |
| mentionGroupIds | array | query | Não | |
| sso | string | query | Não | |
| searchSection | string | query | Não |
Resposta
Retorna: SearchUsersResult
Exemplo

getUser 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: GetUserResponse
Exemplo

createVote 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| commentId | string | query | Sim | |
| direction | string | query | Sim | |
| userId | string | query | Não | |
| anonUserId | string | query | Não |
Resposta
Retorna: VoteResponse
Exemplo

deleteVote 
Parâmetros
| Nome | Tipo | Local | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim | |
| editKey | string | query | Não |
Resposta
Retorna: VoteDeleteResponse
Exemplo

getVotes 
Parâmetros
| Nome | Tipo | Local | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| urlId | string | query | Sim |
Resposta
Retorna: GetVotesResponse
Exemplo

getVotesForUser 
Parameters
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| urlId | string | query | Sim | |
| userId | string | query | Não | |
| anonUserId | string | query | Não |
Response
Retorna: GetVotesForUserResponse
Example

createWebhook 
Inscreve uma URL em um evento de comentário (inscrição de hook REST). Inscrever a mesma URL no mesmo evento e domínio novamente retorna a inscrição existente. As entregas são assinadas com HMAC, veja o guia de webhooks; o cabeçalho legado token nunca é enviado para inscrições de API.
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim |
Resposta
Retorna: CreateWebhookResponse
Exemplo

deleteWebhook 
Cancelamentos de assinatura (REST hook unsubscribe). Apenas assinaturas criadas através desta API podem ser excluídas aqui; webhooks gerenciados pelo dashboard são editados no dashboard.
Parâmetros
| Nome | Tipo | Local | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: APIEmptyResponse
Exemplo

getWebhooks 
Lists the webhooks configurados para o tenant, tanto linhas gerenciadas pelo painel quanto assinaturas de API.
Parameters
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| event | string | query | Não | |
| domain | string | query | Não | |
| source | string | query | Não | |
| skip | number | query | Não |
Response
Retorna: GetWebhooksResponse
Example

getWebhookSamplePayloads 
Recent comments exactly in the format webhook deliveries use, for building integrations (for example Zapier sample data). Every event delivers the same comment object, so event only has to be valid.
Parameters
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| event | string | query | Não | |
| limit | number | query | Não |
Resposta
Retorna: GetWebhookSamplePayloadsResponse
Exemplo

Precisa de ajuda?
Se você encontrar qualquer problema ou tiver dúvidas sobre o SDK Swift, por favor:
Contribuindo
Contribuições são bem-vindas! Visite o repositório no GitHub para as diretrizes de contribuição.