Documentacao da API IAra Help Center
Principal Website
Principal
Categories
🧭 Escopo e primeiros passos
  • Escopo publico da API IAra
  • Base URL, autenticacao e IDs
  • Mapa completo dos recursos de conta
  • Paginacao, filtros e respostas
🪪 Contatos e identificadores
  • Contatos: criar, listar, buscar e atualizar
  • Contatos: filtros, labels, merge e contact inboxes
💬 Conversas e mensagens
  • Conversas: listar, criar, filtrar e atualizar
  • Conversas: atribuicao, status, prioridade, labels e atributos
  • Mensagens, anexos e eventos da conversa
🔌 Client API e canais proprios
  • Client API: criar contato, conversa e mensagem
  • Client API: status, typing, last seen e historico
⚙️ Organizacao da conta
  • Agentes, times, perfil e dados da conta
  • Caixas de entrada e canais
  • Etiquetas, respostas prontas, atributos e filtros
⚡ Automacoes e webhooks
  • Webhooks, automacoes e integration hooks
📊 Relatorios e auditoria
  • Relatorios da conta e metricas de atendimento
  • CSAT, audit logs e eventos de conversa
📚 Central de ajuda via API
  • Portais, categorias e artigos via API
🛠️ Erros e boas praticas
  • Erros HTTP e diagnostico de integracoes
  • Boas praticas de integracao
Principal 📚 Central de ajuda via API
📚

Central de ajuda via API

1 artigo · Suporte Por Suporte
1 artigo · Suporte Por Suporte

Gerenciar portais, categorias e artigos da central no escopo da conta.

Portais, categorias e artigos via API

Portais, categorias e artigos via API A Help Center API permite gerenciar portais, categorias e artigos no escopo da conta quando o recurso esta habilitado. Listar portais curl -X GET "$BASE_URL/api/v1/accounts/$ACCOUNT_ID/portals" \ -H "api_access_token: $API_TOKEN" Criar categoria curl -X POST "$BASE_URL/api/v1/accounts/$ACCOUNT_ID/portals/api-reference/categories" \ -H "api_access_token: $API_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "name":"Primeiros passos", "slug":"primeiros-passos", "description":"Guias iniciais", "position":10, "locale":"pt" }' Criar artigo curl -X POST "$BASE_URL/api/v1/accounts/$ACCOUNT_ID/portals/api-reference/articles" \ -H "api_access_token: $API_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "title":"Visao geral", "slug":"visao-geral", "content":"# Visao geral\nConteudo do artigo.", "description":"Resumo do artigo", "category_id":56, "author_id":35, "status":0, "locale":"pt" }' Status de artigo Use rascunho para revisao antes de publicar. Publique apenas conteudo aprovado e testado.

Feito com Iara Iara