Home API and integrations | Keys, endpoints and webhooks Create or Update an Article in the Help Center

Create or Update an Article in the Help Center

Last updated on Dec 18, 2025

To create a new article in the Cloud Chat Help Center, simply send a POST request to:

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

Example request with fields:

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": "Article content...",
    "status": 0, //Must start as draft!
    "title": "Article Title",
    "author_id": 1,
    "category_id": 1
}'

To publish the article (set status to "published"), you need to make a second request, this time a PUT, changing the status to 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,
    // --- Other fields are optional ---
    //"title": "...",
    //"content": "...",
    //"author_id": 2,
    //"category_id": 20,
}'

Necessary Parameters

CLOUDCHAT_DOMAIN: You can find your domain by logging into your CloudChat account. It's the part that appears in the URL of your browser:

ACCOUNT_ID: Found in your account settings section:

API_TOKEN: Found in your user profile settings in Cloud Chat (https://{{CLOUDCHAT_DOMAIN}}/app/accounts/{{ACCOUNT_ID}}/profile/settings)

author_id and category_id can be found by inspecting the request made in your browser during some change in the articles page: