Inicio API e integraciones | Claves, endpoints y webhooks Crear o actualizar un artículo en la Centro de Ayuda

Crear o actualizar un artículo en la Centro de Ayuda

Última actualización el Dec 18, 2025

Para crear un nuevo artículo en la centro de ayuda de Cloud Chat, simplemente realiza una solicitud POST a:

http://{CLOUDCHAT_DOMAIN}/v1/accounts/{ACCOUNT_ID}/portals/{PORTAL_SLUG}/articles

Solicitud con campos de ejemplo:

curl --location 'http://{CLOUDCHAT_DOMAIN}/api/v1/accounts/{ACCOUNT_ID}/portals/{PORTAL_SLUG}/articles' \
--header 'Content-Type: application/json' \
--header 'api_access_token: BSvG6cFEqsMxKi72F6mvcjWc' \
--data '{
    "content": "Contenido del artículo...",
    "status": 0, //Debe comenzar como borrador!
    "title": "Título del artículo",
    "author_id": 1,
    "category_id": 1
}'

Para marcar el artículo como "publicado" es necesario realizar una segunda solicitud, esta vez un PUT, cambiando el estado a 1:

curl --location --request PUT 'http://{CLOUDCHAT_DOMAIN}/api/v1/accounts/{ACCOUNT_ID}/portals/{PORTAL_SLUG}/articles/{ARTICLE_ID}' \
--header 'Content-Type: application/json' \
--header 'api_access_token: BSvG6cFEqsMxKi72F6mvcjWc' \
--data '{
    "status": 1,
    // --- Los demás campos son opcionales ---
    //"title": "...",
    //"content": "...",
    //"author_id": 2,
    //"category_id": 20,
}'

Parámetros necesarios

CLOUDCHAT_DOMAIN: Puedes obtener tu dominio iniciando sesión en tu cuenta en CloudChat. Es la parte que aparece en la URL del navegador:

ACCOUNT_ID: Obtenido en la sección de configuraciones de la cuenta:

API_TOKEN: Obtenido en la configuración de tu perfil de usuario en Cloud Chat (https://{{CLOUDCHAT_DOMAIN}}/app/accounts/{{ACCOUNT_ID}}/profile/settings)

author_id y category_id se pueden encontrar inspeccionando la solicitud que se realiza en el navegador durante algún cambio en la propia pantalla de artículos: