Principal API e integrações | Chaves, endpoints e webhooks Como criar, atualizar ou deletar artigos na Central de Ajuda via API

Como criar, atualizar ou deletar artigos na Central de Ajuda via API

Última atualização em Sep 23, 2026

A documentação mais atualizada das APIs da Cloud Humans fica em docs.cloudhumans.com/api-reference. Em caso de divergência entre este artigo e a referência, vale o que está lá.

Quando usar

  • Você está automatizando a publicação de artigos na Central de Ajuda do Cloud Chat
  • Você precisa atualizar artigos existentes via integração ou script
  • Você precisa remover artigos via API

Pré-requisitos

Endpoint base

https://{{CLOUDCHAT_DOMAIN}}/api/v1/accounts/{{ACCOUNT_ID}}/portals/{{PORTAL_SLUG}}/articles

Headers (todas as operações)

Header Valor
content-type application/json
api_access_token Seu token de API

Sobre PORTAL_SLUG — é o slug do portal (ex: cloud-chat, meu-portal), não um ID numérico. Você encontra o slug na URL do portal na interface.

Criar artigo

A criação é feita em duas etapas: primeiro POST como rascunho (status=0), depois PUT para publicar (status=1).

Etapa 1 — Criar como rascunho

curl --location 'https://{{CLOUDCHAT_DOMAIN}}/api/v1/accounts/{{ACCOUNT_ID}}/portals/{{PORTAL_SLUG}}/articles' \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: YOUR_TOKEN_HERE' \
  --data '{
    "content": "Conteúdo do artigo...",
    "status": 0,
    "title": "Título do artigo",
    "author_id": 1,
    "category_id": 1
  }'

Crie sempre como status: 0 (rascunho) primeiro. A resposta retorna o id do artigo criado — guarde esse valor para a etapa 2.

Etapa 2 — Publicar (PUT com status=1)

curl --location --request PUT 'https://{{CLOUDCHAT_DOMAIN}}/api/v1/accounts/{{ACCOUNT_ID}}/portals/{{PORTAL_SLUG}}/articles/{{ARTICLE_ID}}' \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: YOUR_TOKEN_HERE' \
  --data '{
    "status": 1
  }'

Atualizar artigo existente

Use PUT com os campos que deseja alterar.

curl --location --request PUT 'https://{{CLOUDCHAT_DOMAIN}}/api/v1/accounts/{{ACCOUNT_ID}}/portals/{{PORTAL_SLUG}}/articles/{{ARTICLE_ID}}' \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: YOUR_TOKEN_HERE' \
  --data '{
    "title": "Novo título",
    "content": "Novo conteúdo...",
    "status": 1
  }'

Campos omitidos no PUT não são alterados — envie só o que mudou.

Campos aceitos

Campo Tipo Descrição
title string Novo título do artigo
content string Novo conteúdo em Markdown
status integer 0 rascunho, 1 publicado
author_id integer ID do autor
category_id integer ID da categoria

Deletar artigo

Use DELETE com body vazio (ou opcional).

curl --location --request DELETE 'https://{{CLOUDCHAT_DOMAIN}}/api/v1/accounts/{{ACCOUNT_ID}}/portals/{{PORTAL_SLUG}}/articles/{{ARTICLE_ID}}' \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: YOUR_TOKEN_HERE'

Esta ação não pode ser desfeita. Confirme o ARTICLE_ID antes de executar.

Onde encontrar os parâmetros

CLOUDCHAT_DOMAIN

Parte da URL ao fazer login na sua conta:

ACCOUNT_ID

Em Configurações da conta:

API_TOKEN

Em https://{{CLOUDCHAT_DOMAIN}}/app/accounts/{{ACCOUNT_ID}}/profile/settings:

author_id e category_id

Inspecione a requisição feita pelo navegador durante uma alteração na própria tela de artigos:

ARTICLE_ID

O ARTICLE_ID que a API espera não é o número que aparece na URL pública do artigo. Esse número é apenas um timestamp gerado no momento da criação e faz parte do slug — usá-lo no PUT ou no DELETE retorna 404.

Para descobrir o ID real, liste os artigos filtrando pelo título e case pelo slug:

curl --location --get 'https://{{CLOUDCHAT_DOMAIN}}/api/v1/accounts/{{ACCOUNT_ID}}/portals/{{PORTAL_SLUG}}/articles' \
  --data-urlencode 'query=palavras do título do artigo' \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: YOUR_TOKEN_HERE'

A resposta traz a lista em payload; o campo id de cada item é o ARTICLE_ID que os endpoints de atualização e deleção esperam.

Exemplo: o artigo de URL pública .../hc/cloud-chat/articles/1766069782-criar-um-artigo-na-central-de-ajuda-via-api tem ARTICLE_ID = 1869.

O parâmetro query faz busca por texto no título, na descrição e no conteúdo. A listagem também aceita locale, category_slug, author_id e status para restringir o resultado.

Observações